> For the complete documentation index, see [llms.txt](https://docs.kognitos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kognitos.com/guides/api-reference/books.md).

# Books

Browse and search books, concepts, procedures, connections, and triggers.

## View Books

> This endpoint returns metadata for all books that are currently available\
> in the runtime, including their names, versions, descriptions, authentication\
> requirements, and capabilities.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBooksResponse":{"type":"object","properties":{"books":{"type":"array","items":{"$ref":"#/components/schemas/v2BookDescriptor"},"title":"All the books that satisfy the query"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of books."}}},"v2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/v2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkV2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"v2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/v2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/v2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"v2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/v2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"v2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/v2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"v2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"bdkV2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/books":{"get":{"summary":"View Books","description":"This endpoint returns metadata for all books that are currently available\nin the runtime, including their names, versions, descriptions, authentication\nrequirements, and capabilities.","operationId":"ListBooks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBooksResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"page_size","description":"The maximum number of books to return.","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page_token","description":"The token to use to retrieve the next page of books.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Book Details

> This endpoint provides comprehensive metadata about a particular book,\
> including its description, author, icon, authentication mechanisms,\
> configuration parameters, and capabilities.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookResponse":{"type":"object","properties":{"book":{"$ref":"#/components/schemas/v2BookDescriptor"}}},"v2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/v2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkV2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"v2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/v2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/v2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"v2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/v2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"v2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/v2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"v2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"bdkV2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/books/{name}/{version}":{"get":{"summary":"View Book Details","description":"This endpoint provides comprehensive metadata about a particular book,\nincluding its description, author, icon, authentication mechanisms,\nconfiguration parameters, and capabilities.","operationId":"GetBook","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Book Procedures

> This endpoint returns a list of all procedures (functions/operations) that\
> can be invoked on the specified book, along with their signatures, input/output\
> parameters, and metadata such as descriptions and examples.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookProceduresResponse":{"type":"object","properties":{"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Available procedures"}},"title":"Retrieve all the available signatures for a book"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/books/{name}/{version}/procedures":{"get":{"summary":"View Book Procedures","description":"This endpoint returns a list of all procedures (functions/operations) that\ncan be invoked on the specified book, along with their signatures, input/output\nparameters, and metadata such as descriptions and examples.","operationId":"ListBookProcedures","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Tags

> This endpoint returns a consolidated list of all tags used across all books\
> in the library. Tags are used for categorizing and organizing books by\
> functionality, domain, or other characteristics.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveTagsResponse":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"title":"Tags"}},"title":"Response to retrieve tags"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/tags":{"get":{"summary":"View Tags","description":"This endpoint returns a consolidated list of all tags used across all books\nin the library. Tags are used for categorizing and organizing books by\nfunctionality, domain, or other characteristics.","operationId":"ListTags","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveTagsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"tags":["Books"],"parameters":[]}}}}
```

## View Latest Books

> This endpoint returns metadata for all books that are currently available\
> in the runtime, including their names, versions, descriptions, authentication\
> requirements, and capabilities.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBooksResponse":{"type":"object","properties":{"books":{"type":"array","items":{"$ref":"#/components/schemas/v2BookDescriptor"},"title":"All the books that satisfy the query"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of books."}}},"v2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/v2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkV2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"v2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/v2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/v2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"v2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/v2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"v2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/v2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"v2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"bdkV2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/books:latest":{"get":{"summary":"View Latest Books","description":"This endpoint returns metadata for all books that are currently available\nin the runtime, including their names, versions, descriptions, authentication\nrequirements, and capabilities.","operationId":"ListLatestBooks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBooksResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"page_size","description":"The maximum number of books to return.","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page_token","description":"The token to use to retrieve the next page of books.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Book Versions

> This endpoint returns a list of all version strings available for the\
> specified book name.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookVersionsResponse":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"string"},"title":"All available versions for the specified book"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/books/{name}/versions":{"get":{"summary":"View Book Versions","description":"This endpoint returns a list of all version strings available for the\nspecified book name.","operationId":"ListBookVersions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookVersionsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Book Concepts

> This endpoint returns a list of concept descriptors defined by the\
> specified book, which can be referenced by procedures as inputs or outputs.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookConceptsResponse":{"type":"object","properties":{"concepts":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Available concepts"}},"title":"Retrieve all the available concept descriptors for a book"},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/books/{name}/{version}/concepts":{"get":{"summary":"View Book Concepts","description":"This endpoint returns a list of concept descriptors defined by the\nspecified book, which can be referenced by procedures as inputs or outputs.","operationId":"ListBookConcepts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookConceptsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Workspace Books

> This endpoint returns metadata for all books that are currently available\
> in the runtime for the specified workspace, including their names, versions,\
> descriptions, authentication requirements, and capabilities.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBooksResponse":{"type":"object","properties":{"books":{"type":"array","items":{"$ref":"#/components/schemas/v2BookDescriptor"},"title":"All the books that satisfy the query"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of books."}}},"v2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/v2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkV2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"v2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/v2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/v2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"v2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/v2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"v2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/v2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"v2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"bdkV2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books":{"get":{"summary":"View Workspace Books","description":"This endpoint returns metadata for all books that are currently available\nin the runtime for the specified workspace, including their names, versions,\ndescriptions, authentication requirements, and capabilities.","operationId":"ListWorkspaceBooks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBooksResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of books to return.","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page_token","description":"The token to use to retrieve the next page of books.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Workspace Book Procedures

> This endpoint returns a list of all procedures (functions/operations) that\
> can be invoked on the specified book in the workspace, along with their signatures,\
> input/output parameters, and metadata such as descriptions and examples.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookProceduresResponse":{"type":"object","properties":{"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Available procedures"}},"title":"Retrieve all the available signatures for a book"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}/procedures":{"get":{"summary":"View Workspace Book Procedures","description":"This endpoint returns a list of all procedures (functions/operations) that\ncan be invoked on the specified book in the workspace, along with their signatures,\ninput/output parameters, and metadata such as descriptions and examples.","operationId":"ListWorkspaceBookProcedures","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Workspace Book Concepts

> This endpoint returns a list of concept descriptors defined by the\
> specified book in the workspace, which can be referenced by procedures as inputs or outputs.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookConceptsResponse":{"type":"object","properties":{"concepts":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Available concepts"}},"title":"Retrieve all the available concept descriptors for a book"},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}/concepts":{"get":{"summary":"View Workspace Book Concepts","description":"This endpoint returns a list of concept descriptors defined by the\nspecified book in the workspace, which can be referenced by procedures as inputs or outputs.","operationId":"ListWorkspaceBookConcepts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookConceptsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Connection Discoverables

> This endpoint returns a list of entities (like database tables, API endpoints,\
> file systems, etc.) that can be discovered from a specific book connection\
> and potentially converted into executable procedures.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveDiscoverablesResponse":{"type":"object","properties":{"discoverables":{"type":"array","items":{"$ref":"#/components/schemas/v2Discoverable"},"title":"The retrieved Discoverables"}},"title":"The response to a get discoverables request"},"v2Discoverable":{"type":"object","properties":{"name":{"type":"string","title":"The name of the discoverable"},"description":{"type":"string","title":"The description of the discoverable"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discoverables":{"get":{"summary":"View Connection Discoverables","description":"This endpoint returns a list of entities (like database tables, API endpoints,\nfile systems, etc.) that can be discovered from a specific book connection\nand potentially converted into executable procedures.","operationId":"ListWorkspaceBookConnectionDiscoverables","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveDiscoverablesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"search","description":"A search term to filter the discoverables","in":"query","required":false,"schema":{"type":"string"}},{"name":"offset","description":"The starting point within the data set from which records will be returned.\nUsed for pagination.","in":"query","required":false,"schema":{"type":"string","format":"uint64"}},{"name":"limit","description":"The maximum number of records to return from the data set.\nUsed for pagination.","in":"query","required":false,"schema":{"type":"string","format":"uint64"}}],"tags":["Books"]}}}}
```

## Search Book Procedures

> This endpoint returns ranked procedures that best match the provided query.\
> Each result includes the owning book name and version, a full procedure descriptor,\
> and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchBookProceduresResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchBookProcedureMatch"},"title":"Ranked list of matches for the given query"}},"title":"Search results for book procedures"},"v2SearchBookProcedureMatch":{"type":"object","properties":{"book_name":{"type":"string","title":"Book name owning the procedure"},"book_version":{"type":"string","title":"Book version owning the procedure"},"procedure":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"}},"title":"A match result for a searched procedure"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"v2SearchBookProceduresRequest":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against procedure metadata and signatures"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"}},"title":"Search for procedures across all available books"}}},"paths":{"/api/v1/procedures:search":{"post":{"summary":"Search Book Procedures","description":"This endpoint returns ranked procedures that best match the provided query.\nEach result includes the owning book name and version, a full procedure descriptor,\nand a relevance score.","operationId":"SearchBookProcedures","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBookProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBookProceduresRequest"}}},"required":true},"tags":["Books"],"parameters":[]}}}}
```

## Search Books

> This endpoint returns ranked books that best match the provided query.\
> Each result includes a full book descriptor and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchBooksResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchBookMatch"},"title":"Ranked list of book matches for the given query"}},"title":"Search results for books"},"v2SearchBookMatch":{"type":"object","properties":{"book":{"$ref":"#/components/schemas/v2BookDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"}},"title":"A match result for a searched book"},"v2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/v2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkV2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"v2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/v2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/v2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"v2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/v2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"v2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/v2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"v2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"bdkV2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"v2SearchBooksRequest":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against book name, version, tags, or descriptions"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"}},"title":"Search for books across the library"}}},"paths":{"/api/v1/books:search":{"post":{"summary":"Search Books","description":"This endpoint returns ranked books that best match the provided query.\nEach result includes a full book descriptor and a relevance score.","operationId":"SearchBooks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBooksResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBooksRequest"}}},"required":true},"tags":["Books"],"parameters":[]}}}}
```

## Search Book Concepts

> This endpoint returns ranked concepts that best match the provided query.\
> Each result includes the owning book name, version, a full concept descriptor, and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchBookConceptsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchBookConceptMatch"},"title":"Ranked list of concept matches for the given query"}},"title":"Search results for book concepts"},"v2SearchBookConceptMatch":{"type":"object","properties":{"book_name":{"type":"string","title":"Book name containing the concept"},"book_version":{"type":"string","title":"Book version containing the concept"},"concept":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"}},"title":"A match result for a searched concept"},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"v2SearchBookConceptsRequest":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against concept names and descriptions"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"}},"title":"Search for concepts across all available books"}}},"paths":{"/api/v1/concepts:search":{"post":{"summary":"Search Book Concepts","description":"This endpoint returns ranked concepts that best match the provided query.\nEach result includes the owning book name, version, a full concept descriptor, and a relevance score.","operationId":"SearchBookConcepts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBookConceptsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBookConceptsRequest"}}},"required":true},"tags":["Books"],"parameters":[]}}}}
```

## Search Workspace Book Procedures

> This endpoint returns ranked procedures that best match the provided query.\
> Each result includes the owning book name and version, a full procedure descriptor,\
> and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchWorkspaceBookProceduresResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchWorkspaceBookProcedureMatch"},"title":"Ranked list of matches for the given query"}},"title":"Search results for workspace book procedures (static and discovered)"},"v2SearchWorkspaceBookProcedureMatch":{"type":"object","properties":{"book_name":{"type":"string","title":"Book name owning the procedure"},"book_version":{"type":"string","title":"Book version owning the procedure"},"procedure":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"},"organization_id":{"type":"string","title":"Organization ID"},"workspace_id":{"type":"string","title":"Workspace ID"},"connection_id":{"type":"string","title":"Connection ID"},"connection_name":{"type":"string","title":"Human-readable connection name (as set by the user)"}},"title":"A match result for a searched procedure (static or discovered)"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SearchWorkspaceBookProceduresBody":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against procedure metadata and signatures"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"},"filter":{"type":"string","description":"Evaluated against the labels on the source BookConnection. Only\n`labels.<name>` fields are supported, with `=`/`!=` comparators,\nAND/OR/NOT composition, and string or boolean values.\nExample: `labels.draft_connection = \"true\"`.","title":"AIP-160 Filtering\nhttps://google.aip.dev/160"}},"title":"Search for procedures across all available books in a workspace"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/procedures:search":{"post":{"summary":"Search Workspace Book Procedures","description":"This endpoint returns ranked procedures that best match the provided query.\nEach result includes the owning book name and version, a full procedure descriptor,\nand a relevance score.","operationId":"SearchWorkspaceBookProcedures","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchWorkspaceBookProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchWorkspaceBookProceduresBody"}}},"required":true},"tags":["Books"]}}}}
```

## Search Connection Procedures

> This endpoint returns ranked procedures that best match the provided query.\
> Each result includes the owning book name and version, a full procedure descriptor,\
> and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchWorkspaceBookProceduresResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchWorkspaceBookProcedureMatch"},"title":"Ranked list of matches for the given query"}},"title":"Search results for workspace book procedures (static and discovered)"},"v2SearchWorkspaceBookProcedureMatch":{"type":"object","properties":{"book_name":{"type":"string","title":"Book name owning the procedure"},"book_version":{"type":"string","title":"Book version owning the procedure"},"procedure":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"},"organization_id":{"type":"string","title":"Organization ID"},"workspace_id":{"type":"string","title":"Workspace ID"},"connection_id":{"type":"string","title":"Connection ID"},"connection_name":{"type":"string","title":"Human-readable connection name (as set by the user)"}},"title":"A match result for a searched procedure (static or discovered)"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SearchWorkspaceBookConnectionProceduresBody":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against procedure metadata and signatures"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"}},"title":"Search for procedures across all available books in a connection"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/procedures:search":{"post":{"summary":"Search Connection Procedures","description":"This endpoint returns ranked procedures that best match the provided query.\nEach result includes the owning book name and version, a full procedure descriptor,\nand a relevance score.","operationId":"SearchWorkspaceBookConnectionProcedures","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchWorkspaceBookProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchWorkspaceBookConnectionProceduresBody"}}},"required":true},"tags":["Books"]}}}}
```

## Search Workspace Books

> This endpoint returns ranked books that best match the provided query.\
> Each result includes a full book descriptor and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchBooksResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchBookMatch"},"title":"Ranked list of book matches for the given query"}},"title":"Search results for books"},"v2SearchBookMatch":{"type":"object","properties":{"book":{"$ref":"#/components/schemas/v2BookDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"}},"title":"A match result for a searched book"},"v2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/v2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkV2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"v2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/v2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/v2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"v2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/v2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"v2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/v2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"v2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"v2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"bdkV2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SearchWorkspaceBooksBody":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against book name, version, tags, or descriptions"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"}},"title":"Search for books across the library in a workspace"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books:search":{"post":{"summary":"Search Workspace Books","description":"This endpoint returns ranked books that best match the provided query.\nEach result includes a full book descriptor and a relevance score.","operationId":"SearchWorkspaceBooks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBooksResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchWorkspaceBooksBody"}}},"required":true},"tags":["Books"]}}}}
```

## Search Workspace Book Concepts

> This endpoint returns ranked concepts that best match the provided query.\
> Each result includes the owning book name, version, a full concept descriptor, and a relevance score.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SearchBookConceptsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v2SearchBookConceptMatch"},"title":"Ranked list of concept matches for the given query"}},"title":"Search results for book concepts"},"v2SearchBookConceptMatch":{"type":"object","properties":{"book_name":{"type":"string","title":"Book name containing the concept"},"book_version":{"type":"string","title":"Book version containing the concept"},"concept":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"score":{"type":"number","format":"double","title":"Relevance score (higher is better)"}},"title":"A match result for a searched concept"},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SearchWorkspaceBookConceptsBody":{"type":"object","properties":{"query":{"type":"string","title":"Free-text search query to match against concept names and descriptions"},"top_k":{"type":"integer","format":"int64","title":"Maximum number of results to return"},"max_distance":{"type":"number","format":"float","title":"Maximum distance threshold for similarity matching"}},"title":"Search for concepts across all available books in a workspace"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/concepts:search":{"post":{"summary":"Search Workspace Book Concepts","description":"This endpoint returns ranked concepts that best match the provided query.\nEach result includes the owning book name, version, a full concept descriptor, and a relevance score.","operationId":"SearchWorkspaceBookConcepts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SearchBookConceptsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchWorkspaceBookConceptsBody"}}},"required":true},"tags":["Books"]}}}}
```

## View Book Connections

> This endpoint returns a list of all connections of a book version.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookConnectionsResponse":{"type":"object","properties":{"book_connections":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"title":"The list of book connections"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of connections."}}},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections":{"get":{"summary":"View Book Connections","description":"This endpoint returns a list of all connections of a book version.","operationId":"ListWorkspaceBookConnections","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookConnectionsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of connections to return.","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page_token","description":"The token to use to retrieve the next page of connections.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Create Book Connection

> This endpoint adds a new book connection, which can be used to invoke\
> procedures on the book.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"AddWorkspaceBookConnectionBody":{"type":"object","properties":{"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration for the connection"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"oauth_flow":{"$ref":"#/components/schemas/v2OAuthFlow"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"auto_upgrade":{"type":"boolean","description":"Whether the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Optional: when unset the\nconnection is created with auto-upgrade enabled. Set to false to pin the\nconnection to book_version."}},"title":"The book connection to add"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections":{"post":{"summary":"Create Book Connection","description":"This endpoint adds a new book connection, which can be used to invoke\nprocedures on the book.","operationId":"AddWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWorkspaceBookConnectionBody"}}},"required":true},"tags":["Books"]}}}}
```

## Update Book Connection

> This endpoint updates a book connection in the library.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"UpdateWorkspaceBookConnectionBody":{"type":"object","properties":{"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Input config"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"oauth_flow":{"$ref":"#/components/schemas/v2OAuthFlow"}},"title":"The book connection to update"},"v2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}":{"put":{"summary":"Update Book Connection","description":"This endpoint updates a book connection in the library.","operationId":"UpdateWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceBookConnectionBody"}}},"required":true},"tags":["Books"]}}}}
```

## View Connection

> This endpoint returns a specific book connection.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookConnectionResponse":{"type":"object","properties":{"book_connection":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"}}},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}":{"get":{"summary":"View Connection","description":"This endpoint returns a specific book connection.","operationId":"GetWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/connections

> View All Connections

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBooksConnectionsResponse":{"type":"object","properties":{"book_connections":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"title":"The list of book connections"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of connections."}}},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections":{"get":{"summary":"View All Connections","operationId":"ListAllWorkspaceBookConnections","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBooksConnectionsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of connections to return.","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page_token","description":"The token to use to retrieve the next page of connections.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filtering\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Upgrade Book Connection

> This endpoint upgrades a book connection to a new version.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"UpgradeWorkspaceBookConnectionBody":{"type":"object","properties":{"new_book_version":{"type":"string","title":"The new version to upgrade book to"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/upgrade":{"put":{"summary":"Upgrade Book Connection","description":"This endpoint upgrades a book connection to a new version.","operationId":"UpgradeWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeWorkspaceBookConnectionBody"}}},"required":true},"tags":["Books"]}}}}
```

## Authorize Connection

> This endpoint generates a new authrization url for an existing book connection.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/authorize":{"put":{"summary":"Authorize Connection","description":"This endpoint generates a new authrization url for an existing book connection.","operationId":"AuthorizeWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Discover Connection Procedures

> This endpoint allows books to discover and register new procedures\
> at runtime by connecting to external APIs, databases, or services.\
> The discovered procedures become available for invocation.\
> \
> Supports:\
> \- Specification of what entities to discover\
> \- Dynamic procedure registration\
> \
> Note: This will override any existing discoverables, and sending an empty list will remove all discoverables.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2DiscoverWorkspaceBookConnectionProceduresResponse":{"type":"object","title":"A response that is sent to reply to a library discovery request"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SetDiscoveredBody":{"type":"object","properties":{"what":{"type":"array","items":{"type":"string"},"title":"What should be discovered"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discover":{"post":{"summary":"Discover Connection Procedures","description":"This endpoint allows books to discover and register new procedures\nat runtime by connecting to external APIs, databases, or services.\nThe discovered procedures become available for invocation.\n\nSupports:\n- Specification of what entities to discover\n- Dynamic procedure registration\n\nNote: This will override any existing discoverables, and sending an empty list will remove all discoverables.","operationId":"SetDiscovered","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DiscoverWorkspaceBookConnectionProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDiscoveredBody"}}},"required":true},"tags":["Books"]}}}}
```

## View Connection Procedures

> This endpoint returns a list of all procedures (functions/operations) that\
> can be invoked on the specified book connection in the workspace, along with their signatures,\
> input/output parameters, and metadata such as descriptions and examples.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookProceduresResponse":{"type":"object","properties":{"procedures":{"type":"array","items":{"$ref":"#/components/schemas/v2BookProcedureDescriptor"},"title":"Available procedures"}},"title":"Retrieve all the available signatures for a book"},"v2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/v2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/v2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/v2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"v2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/v2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/v2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"v2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/procedures":{"get":{"summary":"View Connection Procedures","description":"This endpoint returns a list of all procedures (functions/operations) that\ncan be invoked on the specified book connection in the workspace, along with their signatures,\ninput/output parameters, and metadata such as descriptions and examples.","operationId":"ListWorkspaceBookConnectionProcedures","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookProceduresResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"procedure_ids","description":"Exact procedure identifiers to retrieve (static or discovered).\nEmpty preserves the legacy behavior of returning all procedures.\nUnknown identifiers are omitted; duplicates do not duplicate results.\nDeploy a filter-aware LibraryService before clients rely on bounded responses.","in":"query","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"tags":["Books"]}}}}
```

## POST /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/books/{book\_name}/{book\_version}/connections/{connection\_id}/triggers

> Create Trigger Instance

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2AddWorkspaceBookConnectionTriggerInstanceResponse":{"type":"object","properties":{"trigger_instance":{"$ref":"#/components/schemas/v2TriggerInstance"}}},"v2TriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger instance"},"name":{"type":"string","title":"The name of the trigger instance"},"reference":{"type":"string","title":"The reference of the trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the trigger instance"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/v2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/v2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/v2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkV2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/v2NounPhrases"}}},"v2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2BinaryOperator"},"left":{"$ref":"#/components/schemas/v2Expression"},"right":{"$ref":"#/components/schemas/v2Expression"}}},"v2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"v2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2UnaryOperator"},"inner":{"$ref":"#/components/schemas/v2Expression"}}},"v2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"AddWorkspaceBookConnectionTriggerInstanceBody":{"type":"object","properties":{"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration parameters for the trigger"},"filter_expression":{"$ref":"#/components/schemas/v2Expression"},"name":{"type":"string","title":"The name of the trigger instance"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/triggers":{"post":{"summary":"Create Trigger Instance","operationId":"AddWorkspaceBookConnectionTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2AddWorkspaceBookConnectionTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWorkspaceBookConnectionTriggerInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## POST /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/triggers/{trigger\_instance\_id}/automations

> Set Trigger Automations

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SetAutomationsForTriggerInstanceResponse":{"type":"object","properties":{"trigger_instance":{"$ref":"#/components/schemas/v2TriggerInstance"}}},"v2TriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger instance"},"name":{"type":"string","title":"The name of the trigger instance"},"reference":{"type":"string","title":"The reference of the trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the trigger instance"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/v2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/v2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/v2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkV2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/v2NounPhrases"}}},"v2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2BinaryOperator"},"left":{"$ref":"#/components/schemas/v2Expression"},"right":{"$ref":"#/components/schemas/v2Expression"}}},"v2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"v2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2UnaryOperator"},"inner":{"$ref":"#/components/schemas/v2Expression"}}},"v2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SetAutomationsForTriggerInstanceBody":{"type":"object","properties":{"automation_ids":{"type":"array","items":{"type":"string"},"title":"The identifiers of the automations to attach to the trigger instance"},"connection_id":{"type":"string","title":"The id of the book connection"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers/{trigger_instance_id}/automations":{"post":{"summary":"Set Trigger Automations","operationId":"SetAutomationsForTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SetAutomationsForTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger_instance_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetAutomationsForTriggerInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Set Automations For Trigger Instance

> Attach automations to a trigger instance.\
> The caller sends the full desired list; the existing list is replaced.\
> \
> Both POST and PUT are accepted at the same path. PUT is preferred and\
> matches the replace-collection semantics; the POST binding is retained\
> for backwards compatibility and may be removed in a future version.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SetAutomationsForTriggerInstanceResponse":{"type":"object","properties":{"trigger_instance":{"$ref":"#/components/schemas/v2TriggerInstance"}}},"v2TriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger instance"},"name":{"type":"string","title":"The name of the trigger instance"},"reference":{"type":"string","title":"The reference of the trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the trigger instance"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/v2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/v2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/v2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkV2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/v2NounPhrases"}}},"v2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2BinaryOperator"},"left":{"$ref":"#/components/schemas/v2Expression"},"right":{"$ref":"#/components/schemas/v2Expression"}}},"v2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"v2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2UnaryOperator"},"inner":{"$ref":"#/components/schemas/v2Expression"}}},"v2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceSetAutomationsForTriggerInstanceBody":{"type":"object","properties":{"automation_ids":{"type":"array","items":{"type":"string"},"title":"The identifiers of the automations to attach to the trigger instance"},"connection_id":{"type":"string","title":"The id of the book connection"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers/{trigger_instance_id}/automations":{"put":{"summary":"Set Automations For Trigger Instance","description":"Attach automations to a trigger instance.\nThe caller sends the full desired list; the existing list is replaced.\n\nBoth POST and PUT are accepted at the same path. PUT is preferred and\nmatches the replace-collection semantics; the POST binding is retained\nfor backwards compatibility and may be removed in a future version.","operationId":"SetWorkspaceAutomationsForTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SetAutomationsForTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger_instance_id","description":"The identifier of the trigger instance","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceSetAutomationsForTriggerInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Update Workspace Book Connection Trigger Instance

> Updates an existing trigger instance's name, configuration, and filter expression.\
> Uses PUT semantics - all fields are required and will replace the existing values.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2UpdateWorkspaceBookConnectionTriggerInstanceResponse":{"type":"object","properties":{"trigger_instance":{"$ref":"#/components/schemas/v2TriggerInstance"}}},"v2TriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger instance"},"name":{"type":"string","title":"The name of the trigger instance"},"reference":{"type":"string","title":"The reference of the trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the trigger instance"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/v2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/v2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/v2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkV2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/v2NounPhrases"}}},"v2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2BinaryOperator"},"left":{"$ref":"#/components/schemas/v2Expression"},"right":{"$ref":"#/components/schemas/v2Expression"}}},"v2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"v2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2UnaryOperator"},"inner":{"$ref":"#/components/schemas/v2Expression"}}},"v2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceUpdateWorkspaceBookConnectionTriggerInstanceBody":{"type":"object","properties":{"name":{"type":"string","title":"The name of the trigger instance (required for PUT semantics)"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"description":"Configuration parameters for the trigger (required for PUT semantics).\nEmpty map clears the configuration."},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/triggers/{trigger_instance_id}":{"put":{"summary":"Update Workspace Book Connection Trigger Instance","description":"Updates an existing trigger instance's name, configuration, and filter expression.\nUses PUT semantics - all fields are required and will replace the existing values.","operationId":"UpdateWorkspaceBookConnectionTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2UpdateWorkspaceBookConnectionTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger_instance_id","description":"The identifier of the trigger instance to update","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceUpdateWorkspaceBookConnectionTriggerInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## DELETE /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/connections/{connection\_id}/triggers/{trigger\_instance\_id}

> Delete Trigger Instance

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RemoveWorkspaceBookConnectionTriggerInstanceResponse":{"type":"object"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/triggers/{trigger_instance_id}":{"delete":{"summary":"Delete Trigger Instance","operationId":"RemoveWorkspaceBookConnectionTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RemoveWorkspaceBookConnectionTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger_instance_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/triggers

> View Trigger Instances

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveWorkspaceTriggerInstancesResponse":{"type":"object","properties":{"trigger_instances":{"type":"array","items":{"$ref":"#/components/schemas/v2TriggerInstance"},"title":"The trigger instances"}}},"v2TriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger instance"},"name":{"type":"string","title":"The name of the trigger instance"},"reference":{"type":"string","title":"The reference of the trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the trigger instance"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/v2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/v2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/v2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkV2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/v2NounPhrases"}}},"v2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2BinaryOperator"},"left":{"$ref":"#/components/schemas/v2Expression"},"right":{"$ref":"#/components/schemas/v2Expression"}}},"v2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"v2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/v2UnaryOperator"},"inner":{"$ref":"#/components/schemas/v2Expression"}}},"v2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers":{"get":{"summary":"View Trigger Instances","operationId":"ListWorkspaceTriggerInstances","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveWorkspaceTriggerInstancesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## View Connection User Info

> This endpoint returns information about the user (email, username and other extra attributes) from\
> &#x20;a book that has already been connected.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveUserInfoResponse":{"type":"object","properties":{"user_info":{"$ref":"#/components/schemas/v2UserInfo"}},"title":"The response to a retrieve user info request"},"v2UserInfo":{"type":"object","properties":{"email":{"type":"string","title":"The email of the user"},"username":{"type":"string","title":"The username of the user"},"other_attributes":{"type":"object","additionalProperties":{"type":"string"},"title":"A map with other extra attributes the user may have"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/user-info":{"get":{"summary":"View Connection User Info","description":"This endpoint returns information about the user (email, username and other extra attributes) from\n a book that has already been connected.","operationId":"GetWorkspaceBookConnectionUserInfo","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveUserInfoResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Test Connection

> Tests the connectivity and authentication for a specific book.\
> \
> This endpoint validates that the provided authentication credentials work\
> correctly with the specified book. It's used to verify book connectivity\
> before attempting to invoke procedures that require authentication.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"bdkv1TestConnectionResponse":{"type":"object"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"bdkv1Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1CredentialValue"},"title":"Credentials"}}},"bdkv1CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkv1Value"}}},"bdkv1Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv1NounPhrase"},"text_value":{"type":"string"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv1Date"},"time_value":{"$ref":"#/components/schemas/bdkv1Time"},"file_value":{"$ref":"#/components/schemas/bdkv1FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv1DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv1ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv1OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv1TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv1SensitiveValue"}},"title":"A union of all possible values"},"bdkv1NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv1Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv1Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv1FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv1File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv1File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv1DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv1DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv1Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv1ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv1OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv1TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv1Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv1Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv1Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv1Value"}},"name":{"type":"string"}}},"bdkv1SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv1Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"}}},"paths":{"/api/v1/books/{name}/{version}/test-connection":{"post":{"summary":"Test Connection","description":"Tests the connectivity and authentication for a specific book.\n\nThis endpoint validates that the provided authentication credentials work\ncorrectly with the specified book. It's used to verify book connectivity\nbefore attempting to invoke procedures that require authentication.","operationId":"TestConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bdkv1TestConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"name","description":"The name of the book for which the connection will be tested","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","description":"The version of the book for which the connection will be tested","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bdkv1Authentication"}}},"description":"Authentication information","required":true},"tags":["Books"]}}}}
```

## Retrieve Workspace Agent Trigger Instances

> Retrieve all agent trigger instances for a workspace.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveWorkspaceAgentTriggerInstancesResponse":{"type":"object","properties":{"agent_trigger_instances":{"type":"array","items":{"$ref":"#/components/schemas/v2AgentTriggerInstance"},"title":"The agent trigger instances"}}},"v2AgentTriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the agent trigger instance"},"name":{"type":"string","title":"The name of the agent trigger instance"},"reference":{"type":"string","title":"The reference of the agent trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the agent trigger instance"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"Identifiers of the rain agents to invoke when the trigger fires. Each\nagent gets its own thread and message; the prompt is sent to all."},"prompt":{"type":"string","title":"Literal prompt sent to the rain agent as the user message"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/agent-triggers":{"get":{"summary":"Retrieve Workspace Agent Trigger Instances","description":"Retrieve all agent trigger instances for a workspace.","operationId":"RetrieveWorkspaceAgentTriggerInstances","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveWorkspaceAgentTriggerInstancesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Add Workspace Book Connection With Remote Secret

> Adds a book connection backed by a managed credential (referenced by id),\
> for books whose runtime supports remote secrets. Carries no inline\
> authentication values.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceAddWorkspaceBookConnectionWithRemoteSecretBody":{"type":"object","properties":{"connection_name":{"type":"string","title":"The connection name"},"credentials_id":{"type":"string","description":"The id of the managed credential backing this connection (resolved at\ninvoke). Required."},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration for the connection"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Label"},"title":"Labels associated with the connection"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"authentication_id":{"type":"string","description":"The id of the book authentication method this credential is for. Sets the\nconnection's authenticationId so the runtime knows which method to resolve\n(the credential values themselves come from the managed store)."}},"description":"Add a book connection whose credential is a managed secret referenced by id.\nThe connection carries no inline authentication values — the runtime resolves\nthe credential from the managed store at invoke."},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"bdkv2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/with-remote-secret":{"post":{"summary":"Add Workspace Book Connection With Remote Secret","description":"Adds a book connection backed by a managed credential (referenced by id),\nfor books whose runtime supports remote secrets. Carries no inline\nauthentication values.","operationId":"AddWorkspaceBookConnectionWithRemoteSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","description":"The name of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","description":"The version of the book","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceAddWorkspaceBookConnectionWithRemoteSecretBody"}}},"required":true},"tags":["Books"]}}}}
```

## Add Workspace Book Connection Agent Trigger Instance

> Adds a new agent trigger instance to a book connection.\
> An agent trigger fires a single rain agent (identified by agent\_id) with the\
> configured literal prompt when the trigger condition is met.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2AddWorkspaceBookConnectionAgentTriggerInstanceResponse":{"type":"object","properties":{"agent_trigger_instance":{"$ref":"#/components/schemas/v2AgentTriggerInstance"}}},"v2AgentTriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the agent trigger instance"},"name":{"type":"string","title":"The name of the agent trigger instance"},"reference":{"type":"string","title":"The reference of the agent trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the agent trigger instance"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"Identifiers of the rain agents to invoke when the trigger fires. Each\nagent gets its own thread and message; the prompt is sent to all."},"prompt":{"type":"string","title":"Literal prompt sent to the rain agent as the user message"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceAddWorkspaceBookConnectionAgentTriggerInstanceBody":{"type":"object","properties":{"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the trigger"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"},"name":{"type":"string","title":"The name of the agent trigger instance"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"Identifiers of the rain agents to invoke when the trigger fires. Each\nagent gets its own thread and message; the prompt is sent to all."},"prompt":{"type":"string","title":"Literal prompt sent to the rain agent as the user message"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/agent-triggers":{"post":{"summary":"Add Workspace Book Connection Agent Trigger Instance","description":"Adds a new agent trigger instance to a book connection.\nAn agent trigger fires a single rain agent (identified by agent_id) with the\nconfigured literal prompt when the trigger condition is met.","operationId":"AddWorkspaceBookConnectionAgentTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2AddWorkspaceBookConnectionAgentTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","description":"The name of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","description":"The version of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceAddWorkspaceBookConnectionAgentTriggerInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Copy And Upgrade Workspace Book Connection

> Copy a book connection and upgrade the copy to a new version.\
> \
> Unlike UpgradeWorkspaceBookConnection, this endpoint does not mutate the\
> source connection. It creates a brand-new BookConnection (with a fresh\
> connection\_id) at new\_book\_version, carrying over the source connection's\
> credentials and configuration so the user does not have to re-enter them.\
> Automations attached to the source connection are not migrated; the caller\
> decides which automations (if any) to re-point at the new connection.\
> \
> new\_book\_version must differ from book\_version.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceCopyAndUpgradeWorkspaceBookConnectionBody":{"type":"object","properties":{"new_book_version":{"type":"string","description":"The new version to upgrade book to on the copied connection.\nMust differ from book_version; same-version copies are not supported."}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/copy-and-upgrade":{"post":{"summary":"Copy And Upgrade Workspace Book Connection","description":"Copy a book connection and upgrade the copy to a new version.\n\nUnlike UpgradeWorkspaceBookConnection, this endpoint does not mutate the\nsource connection. It creates a brand-new BookConnection (with a fresh\nconnection_id) at new_book_version, carrying over the source connection's\ncredentials and configuration so the user does not have to re-enter them.\nAutomations attached to the source connection are not migrated; the caller\ndecides which automations (if any) to re-point at the new connection.\n\nnew_book_version must differ from book_version.","operationId":"CopyAndUpgradeWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","description":"The name of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","description":"The current version of the book on the source connection","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the source book connection to copy from","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceCopyAndUpgradeWorkspaceBookConnectionBody"}}},"required":true},"tags":["Books"]}}}}
```

## Add Workspace Book Connection Poll Instance

> Adds a poll instance for a workspace book connection.\
> \
> Polls are long-running background tasks that continuously monitor\
> external systems for changes or new data. This endpoint:\
> \- Creates a new poll instance with a unique identifier\
> \- Starts the polling loop in the background\
> \- Returns the created poll instance\
> \
> The poll instance is scoped to a workspace book connection, which\
> provides the authentication credentials for accessing external systems.\
> Configuration parameters can be provided to customize polling behavior.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2AddWorkspaceBookConnectionPollInstanceResponse":{"type":"object","properties":{"poll_instance":{"$ref":"#/components/schemas/v2PollInstance"}}},"v2PollInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll instance"},"name":{"type":"string","title":"The name of the poll instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"poll_id":{"type":"string","title":"The identifier of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the poll"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"status":{"$ref":"#/components/schemas/v2PollInstanceStatus"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs associated with this poll instance"},"poll_interval_minutes":{"type":"integer","format":"int64","title":"The poll interval in minutes"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2PollInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2PollInstanceState"},"state_category":{"$ref":"#/components/schemas/v2PollInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"last_checkpoint":{"type":"string","title":"ID of the last processed entry, used to resume polling after restart"}},"title":"Status information for a PollInstance"},"v2PollInstanceState":{"type":"string","enum":["POLL_INSTANCE_STATE_PENDING","POLL_INSTANCE_STATE_READY","POLL_INSTANCE_STATE_FAILED","POLL_INSTANCE_STATE_UNKNOWN"],"default":"POLL_INSTANCE_STATE_PENDING","title":"Possible phases for a PollInstance (Pending, Ready, Failed, Unknown)"},"v2PollInstanceStateCategory":{"type":"string","enum":["POLL_INSTANCE_STATE_CATEGORY_WARNING","POLL_INSTANCE_STATE_CATEGORY_READY","POLL_INSTANCE_STATE_CATEGORY_FAILED"],"default":"POLL_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the poll instance state"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceAddWorkspaceBookConnectionPollInstanceBody":{"type":"object","properties":{"poll_id":{"type":"string","title":"The identifier of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the poll"},"name":{"type":"string","title":"The name of the poll instance"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs to associate with this poll instance"},"poll_interval_minutes":{"type":"integer","format":"int64","title":"The poll interval in minutes"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/polls":{"post":{"summary":"Add Workspace Book Connection Poll Instance","description":"Adds a poll instance for a workspace book connection.\n\nPolls are long-running background tasks that continuously monitor\nexternal systems for changes or new data. This endpoint:\n- Creates a new poll instance with a unique identifier\n- Starts the polling loop in the background\n- Returns the created poll instance\n\nThe poll instance is scoped to a workspace book connection, which\nprovides the authentication credentials for accessing external systems.\nConfiguration parameters can be provided to customize polling behavior.","operationId":"AddWorkspaceBookConnectionPollInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2AddWorkspaceBookConnectionPollInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","description":"The name of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","description":"The version of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceAddWorkspaceBookConnectionPollInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Upgrade Workspace Book Connection With Remote Secret

> Upgrade a connection onto a credential-capable book version, migrating its\
> credential into the managed store. The runtime mints the managed credential\
> from the connection's existing (legacy) secret and attaches it.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceUpgradeWorkspaceBookConnectionWithRemoteSecretBody":{"type":"object","properties":{"new_book_version":{"type":"string","title":"The new version to upgrade book to"},"credentials_id":{"type":"string","description":"Existing managed credential to attach. Omit to migrate the connection's\nlegacy secret into a new managed credential instead."}},"description":"Upgrade a connection onto a credential-capable book version. When\n`credentials_id` is set the connection is pointed at that existing managed\ncredential; when omitted, the runtime migrates the connection's existing\n(legacy) secret into a new managed credential during the upgrade."}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/upgrade-with-remote-secret":{"put":{"summary":"Upgrade Workspace Book Connection With Remote Secret","description":"Upgrade a connection onto a credential-capable book version, migrating its\ncredential into the managed store. The runtime mints the managed credential\nfrom the connection's existing (legacy) secret and attaches it.","operationId":"UpgradeWorkspaceBookConnectionWithRemoteSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","description":"The name of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","description":"The existing version of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection to upgrade","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceUpgradeWorkspaceBookConnectionWithRemoteSecretBody"}}},"required":true},"tags":["Books"]}}}}
```

## Update Workspace Book Connection With Remote Secret

> Updates a credential-backed book connection (re-point the managed credential\
> and/or update config/labels). Carries no inline authentication values.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceUpdateWorkspaceBookConnectionWithRemoteSecretBody":{"type":"object","properties":{"connection_name":{"type":"string","title":"The connection name"},"credentials_id":{"type":"string","description":"The id of the managed credential backing this connection (resolved at\ninvoke)."},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration for the connection"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Label"},"title":"Labels associated with the connection"},"authentication_id":{"type":"string","description":"The id of the book authentication method this credential is for. Sets the\nconnection's authenticationId so the runtime knows which method to resolve\n(the credential values themselves come from the managed store)."}},"description":"Update a credential-backed book connection. Re-points the connection at a\nmanaged credential (by id) and/or updates config/labels. Carries no inline\nauthentication values."},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"bdkv2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/with-remote-secret":{"put":{"summary":"Update Workspace Book Connection With Remote Secret","description":"Updates a credential-backed book connection (re-point the managed credential\nand/or update config/labels). Carries no inline authentication values.","operationId":"UpdateWorkspaceBookConnectionWithRemoteSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_name","description":"The name of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"book_version","description":"The version of the book","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The id of the connection to update","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceUpdateWorkspaceBookConnectionWithRemoteSecretBody"}}},"required":true},"tags":["Books"]}}}}
```

## Retrieve Workspace Book Versions

> Retrieves all available versions for a specific book visible in a workspace.\
> \
> This endpoint returns a list of all version strings available for the\
> specified book name in the workspace context (global + workspace-private).

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBookVersionsResponse":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"string"},"title":"All available versions for the specified book"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/versions":{"get":{"summary":"Retrieve Workspace Book Versions","description":"Retrieves all available versions for a specific book visible in a workspace.\n\nThis endpoint returns a list of all version strings available for the\nspecified book name in the workspace context (global + workspace-private).","operationId":"RetrieveWorkspaceBookVersions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBookVersionsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Organization identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"Workspace identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","description":"The name of the book to retrieve versions for","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Retrieve Workspace Book

> Retrieves detailed information about a specific book version in a workspace.\
> \
> This endpoint provides comprehensive metadata about a particular book in\
> the workspace context, including books that are private to the workspace\
> and not visible in the global library.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"bdkv2RetrieveBookResponse":{"type":"object","properties":{"book":{"$ref":"#/components/schemas/bdkv2BookDescriptor"}}},"bdkv2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkv2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"bdkv2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/bdkv2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/bdkv2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"bdkv2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"bdkv2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/bdkv2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"bdkv2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/bdkv2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"bdkv2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"bdkv2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"bdkv2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"bdkv2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}}},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"bdkv2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/bdkv2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/bdkv2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"bdkv2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"bdkv2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"bdkv2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkv2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}":{"get":{"summary":"Retrieve Workspace Book","description":"Retrieves detailed information about a specific book version in a workspace.\n\nThis endpoint provides comprehensive metadata about a particular book in\nthe workspace context, including books that are private to the workspace\nand not visible in the global library.","operationId":"RetrieveWorkspaceBook","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bdkv2RetrieveBookResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Organization identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"Workspace identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","description":"The name of the book to be retrieved","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","description":"The version of the book to be retrieved","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Retrieve Latest Workspace Books

> Retrieves the latest version of every book available in the workspace.\
> \
> This endpoint returns metadata for the latest version of each book that is\
> currently available in the runtime for the specified workspace. The result is\
> the union of global library books and any workspace-private books.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"bdkv2RetrieveBooksResponse":{"type":"object","properties":{"books":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2BookDescriptor"},"title":"All the books that satisfy the query"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of books."}}},"bdkv2BookDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"@deprecated, use name and version to uniquely identify a book","title":"The identifier of the book (a.k.a integration_id)"},"name":{"type":"string","title":"The name of the book"},"short_description":{"type":"string","title":"Short description of the book"},"long_description":{"type":"string","title":"Short description of the book"},"author":{"type":"string","title":"Author of the book"},"icon":{"type":"string","format":"byte","title":"Icon of the book in an image format that is web-compatible (i.e. JPG, PNG, SVG, WebP)"},"version":{"type":"string","title":"Version of the book"},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2BookAuthenticationDescriptor"},"title":"Authentication mechanism for a book version"},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book. Note: replaced by config_map"},"display_name":{"type":"string","title":"Display name of the book"},"endpoint":{"type":"string","title":"URI location of the book, such as lambda://microsoft/1.0.4"},"connection_required":{"type":"boolean","description":"Connection Required. True if all procedures always require a connection."},"discover_capable":{"type":"boolean","title":"True if the book is capable of discovering book procedures"},"tags":{"type":"array","items":{"type":"string"},"title":"Tags associated with the book"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2BookProcedureDescriptor"},"title":"Book procedures"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"userinfo_capable":{"type":"boolean","title":"True if the book is capable of returning oauth user's info"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/v2BookTriggerDescriptor"},"title":"Book triggers"},"bdk_runtime_version":{"type":"string","title":"BDK Runtime version"},"environment_information":{"$ref":"#/components/schemas/bdkv2EnvironmentInformation"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the parameters available for configuring the behaviour of this book"},"hidden":{"type":"boolean","title":"True if the book is hidden"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/v2BookPollDescriptor"},"title":"Book polls"},"supports_remote_secret":{"type":"boolean","description":"True if this book's runtime can resolve connection credentials from a\nmanaged secret store (referenced by credential id) instead of inline\nauthentication values. Runtime-injected — a book gains this by running on a\ncapable runtime. Absent/false = legacy (inline authentication only)."}}},"bdkv2BookAuthenticationDescriptor":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/bdkv2BookCustomAuthenticationDescriptor"},"oauth":{"$ref":"#/components/schemas/bdkv2BookOAuthAuthenticationDescriptor"},"secret_type_id":{"type":"string","description":"Optional secret type id this auth method's credential conforms to. Lets a\nbook share a credential shape across books/services (e.g. \"anthropic_api_key\")\ninstead of the per-book default. When unset, the default `bdk.{book}.{authId}`\nis used. Lives on the wrapper (not per-variant) so it covers custom and oauth\nalike."}}},"bdkv2BookCustomAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2CredentialDescriptor"},"title":"Credentials required to perform authentication"},"description":{"type":"string","title":"A description of the authentication"},"name":{"type":"string","title":"A name for the authentication"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"bdkv2CredentialDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"type":{"$ref":"#/components/schemas/bdkv2CredentialType"},"label":{"type":"string","title":"Label that will be displayed to the user during configuration of the book"},"visible":{"type":"boolean","description":"True if the value is visible to the book, false otherwise."},"description":{"type":"string","title":"Description"}}},"bdkv2CredentialType":{"type":"string","enum":["CredentialTypeText","CredentialTypeSensitiveText","CredentialTypeSensitiveDictionary"],"default":"CredentialTypeText","title":"Supported configuration types"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2BookOAuthAuthenticationDescriptor":{"type":"object","properties":{"id":{"type":"string","description":"Since books can have multiple authentication mechanisms there is\nand ID to differentiate each mechanism."},"provider":{"$ref":"#/components/schemas/bdkv2OAuthProvider"},"flows":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2OAuthFlow"},"title":"Supported OAuth flows"},"authorize_endpoint":{"type":"string","title":"Authorize endpoint"},"token_endpoint":{"type":"string","title":"Token endpoint"},"scope":{"type":"array","items":{"type":"string"},"title":"Scopes"},"name":{"type":"string","title":"A name for the authentication"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2OAuthArgumentDescriptor"},"title":"Additional arguments which are not part of the OAuth specification\nbut are required for the authentication to work (such as tenant_id)"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2CredentialDescriptor"},"title":"Credential descriptors"},"preferred":{"type":"boolean","title":"If this is a preferred authentication method"},"parameter_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional mapping of standard OAuth parameter names to provider-specific\nnames. For example, Slack requires scopes to be sent as \"user_scope\"\ninstead of \"scope\" on the authorize URL:\n  { \"scope\": \"user_scope\" }\nThe runtime uses this to rename parameters when constructing the\nauthorize and token exchange requests."},"deprecated":{"type":"boolean","title":"If this authentication method is deprecated"}}},"bdkv2OAuthProvider":{"type":"string","enum":["OAuthProviderMicrosoft","OAuthProviderGoogle","OAuthProviderGeneric"],"default":"OAuthProviderMicrosoft","title":"Supported OAuth providers"},"bdkv2OAuthFlow":{"type":"string","enum":["OAuthFlowAuthorizationCode","OAuthFlowClientCredentials"],"default":"OAuthFlowAuthorizationCode","title":"Supported OAuth flows"},"bdkv2OAuthArgumentDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the parameter"},"name":{"type":"string","title":"Name of the parameter"},"description":{"type":"string","title":"Description of the parameter"}}},"bdkv2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}}},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"bdkv2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/bdkv2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/bdkv2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/bdkv2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/bdkv2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/bdkv2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/bdkv2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/bdkv2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/bdkv2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/bdkv2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/bdkv2ConceptEnumType"}}},"bdkv2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"bdkv2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"bdkv2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"bdkv2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string"}}},"bdkv2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"description":{"type":"string"}}},"bdkv2ConceptAnyType":{"type":"object"},"bdkv2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptType"}}}},"bdkv2ConceptSelfType":{"type":"object"},"bdkv2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"bdkv2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"bdkv2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"description":{"type":"string"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"bdkv2BookProcedureDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"Id of the procedure to use in subsequent calls"},"signature":{"$ref":"#/components/schemas/bdkv2BookProcedureSignature"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the inputs for the procedure (required and non required)"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2ConceptDescriptor"},"title":"All the outputs for the procedure"},"short_description":{"type":"string","title":"Short description"},"long_description":{"type":"string","title":"Longer description"},"filter_capable":{"type":"boolean","title":"Can this procedure filter its response?"},"page_capable":{"type":"boolean","title":"Can this procedure page its response?"},"connection_required":{"$ref":"#/components/schemas/bdkv2ConnectionRequired"},"is_discovered":{"type":"boolean","title":"True if the procedure was discovered"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2QuestionDescriptor"},"title":"Questions the procedure may ask"},"is_async":{"type":"boolean","title":"Does the procedure return a promise?"},"is_mutation":{"type":"boolean","title":"True if the procedures performs a mutating action"},"search_hints":{"type":"array","items":{"type":"string"},"title":"Search hints used for procedure resolution"},"spy_signature":{"$ref":"#/components/schemas/v2SpySignatureDescriptor"}}},"bdkv2BookProcedureSignature":{"type":"object","properties":{"english":{"type":"string"},"verbs":{"type":"array","items":{"type":"string"},"title":"Verb of the signature"},"object":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"preposition":{"type":"string","title":"Preposition"},"target":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"title":"Outputs"},"proper_nouns":{"type":"array","items":{"type":"string"},"title":"All the proper nouns that appear on this signature"}}},"bdkv2ConnectionRequired":{"type":"string","enum":["Optional","Always","Never"],"default":"Optional","title":"Connection required"},"bdkv2QuestionDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/bdkv2NounPhrases"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"}}},"v2SpySignatureDescriptor":{"type":"object","properties":{"function_name":{"type":"string","title":"Name of the function"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v2SpyArgumentDescriptor"},"title":"Arguments of the function, in call order"},"return_type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the procedure"}},"title":"The SPy signature of a book procedure"},"v2SpyArgumentDescriptor":{"type":"object","properties":{"name":{"type":"string","title":"SPy keyword-argument name"},"type":{"$ref":"#/components/schemas/bdkv2ConceptType"},"description":{"type":"string","title":"Description of the argument"},"required":{"type":"boolean","title":"False if the argument can be omitted from the call"},"default_value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"An argument of a SpySignatureDescriptor"},"v2BookTriggerDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the trigger"},"name":{"type":"string","title":"The name of the trigger"},"description":{"type":"string","title":"Description of the trigger"},"setup_description":{"type":"string","title":"Setup description for the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the trigger"},"filter_capable":{"type":"boolean","title":"True if the trigger is capable of filtering events"},"is_manual":{"type":"boolean","title":"True if the trigger is manually invoked"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the trigger"},"is_shared_endpoint":{"type":"boolean","description":"True if every trigger instance of this trigger shares the same endpoint when configured."}}},"v2ConceptDescriptor":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"type":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string","title":"Description"},"default_value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"v2ConceptType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v2ConceptScalarType"},"optional_type":{"$ref":"#/components/schemas/v2ConceptOptionalType"},"list_type":{"$ref":"#/components/schemas/v2ConceptListType"},"dictionary_type":{"$ref":"#/components/schemas/v2ConceptDictionaryType"},"table_type":{"$ref":"#/components/schemas/v2ConceptTableType"},"opaque_type":{"$ref":"#/components/schemas/v2ConceptOpaqueType"},"any_type":{"$ref":"#/components/schemas/v2ConceptAnyType"},"union_type":{"$ref":"#/components/schemas/v2ConceptUnionType"},"self_type":{"$ref":"#/components/schemas/v2ConceptSelfType"},"sensitive_type":{"$ref":"#/components/schemas/v2ConceptSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v2ConceptEnumType"}}},"v2ConceptScalarType":{"type":"string","enum":["ConceptScalarTypeConceptual","ConceptScalarTypeText","ConceptScalarTypeNumber","ConceptScalarTypeBoolean","ConceptScalarTypeDatetime","ConceptScalarTypeDate","ConceptScalarTypeTime","ConceptScalarTypeFile","ConceptScalarTypeUUID"],"default":"ConceptScalarTypeConceptual","title":"Supported concept types"},"v2ConceptOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptDictionaryType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptDictionaryTypeField"}},"description":{"type":"string"}}},"v2ConceptDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptTableType":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptTableTypeColumn"}},"description":{"type":"string"}}},"v2ConceptTableTypeColumn":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/v2ConceptType"},"description":{"type":"string"}}},"v2ConceptOpaqueType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"description":{"type":"string"}}},"v2ConceptAnyType":{"type":"object"},"v2ConceptUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptType"}}}},"v2ConceptSelfType":{"type":"object"},"v2ConceptSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v2ConceptType"}}},"v2ConceptEnumType":{"type":"object","properties":{"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptEnumTypeMember"}},"description":{"type":"string"}}},"v2ConceptEnumTypeMember":{"type":"object","properties":{"name":{"type":"string"},"noun_phrase":{"$ref":"#/components/schemas/v2NounPhrase"},"description":{"type":"string"}}},"bdkv2EnvironmentInformation":{"type":"object","properties":{"version":{"type":"string"},"runtime_name":{"type":"string","title":"Runtime name"},"runtime_version":{"type":"string","title":"Runtime version"},"bci_protocol_version":{"type":"string","title":"BCI Protocol version"},"api_version":{"type":"string","title":"BDK API Version"},"path":{"type":"array","items":{"type":"string"},"title":"Book path under which books will be discovered"}},"title":"Information about the environment"},"v2BookPollDescriptor":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll"},"name":{"type":"string","title":"The name of the poll"},"description":{"type":"string","title":"Description of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Configuration parameters for the poll"},"event_type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v2ConceptDescriptor"},"title":"Event type schema for the poll"},"filter_capable":{"type":"boolean","title":"True if the poll is capable of filtering events at the source"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books:latest":{"get":{"summary":"Retrieve Latest Workspace Books","description":"Retrieves the latest version of every book available in the workspace.\n\nThis endpoint returns metadata for the latest version of each book that is\ncurrently available in the runtime for the specified workspace. The result is\nthe union of global library books and any workspace-private books.","operationId":"RetrieveLatestWorkspaceBooks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bdkv2RetrieveBooksResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Organization identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"Workspace identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of books to return.","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page_token","description":"The token to use to retrieve the next page of books.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Update Workspace Book Connection Agent Trigger Instance

> Updates an existing agent trigger instance.\
> Uses PUT semantics - all fields are required and will replace the existing values.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2UpdateWorkspaceBookConnectionAgentTriggerInstanceResponse":{"type":"object","properties":{"agent_trigger_instance":{"$ref":"#/components/schemas/v2AgentTriggerInstance"}}},"v2AgentTriggerInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the agent trigger instance"},"name":{"type":"string","title":"The name of the agent trigger instance"},"reference":{"type":"string","title":"The reference of the agent trigger instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"trigger_id":{"type":"string","title":"The name of the trigger"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the trigger"},"endpoint":{"type":"string","title":"The endpoint of the agent trigger instance"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"Identifiers of the rain agents to invoke when the trigger fires. Each\nagent gets its own thread and message; the prompt is sent to all."},"prompt":{"type":"string","title":"Literal prompt sent to the rain agent as the user message"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"},"status":{"$ref":"#/components/schemas/v2TriggerInstanceStatus"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"v2TriggerInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2TriggerInstanceState"},"state_category":{"$ref":"#/components/schemas/v2TriggerInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"}},"title":"Status information for a BookConnection"},"v2TriggerInstanceState":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_PENDING","TRIGGER_INSTANCE_STATE_READY","TRIGGER_INSTANCE_STATE_FAILED","TRIGGER_INSTANCE_STATE_UNKNOWN"],"default":"TRIGGER_INSTANCE_STATE_PENDING","title":"Possible phases for a TriggerInstance (Pending, Ready, Failed, Unknown)"},"v2TriggerInstanceStateCategory":{"type":"string","enum":["TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","TRIGGER_INSTANCE_STATE_CATEGORY_READY","TRIGGER_INSTANCE_STATE_CATEGORY_FAILED"],"default":"TRIGGER_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceUpdateWorkspaceBookConnectionAgentTriggerInstanceBody":{"type":"object","properties":{"name":{"type":"string","title":"The name of the agent trigger instance (required for PUT semantics)"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"description":"Configuration parameters for the trigger (required for PUT semantics).\nEmpty map clears the configuration."},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"Identifiers of the rain agents to invoke when the trigger fires (required for PUT semantics).\nEach agent gets its own thread and message; the prompt is sent to all."},"prompt":{"type":"string","title":"Literal prompt sent to the rain agent as the user message (required for PUT semantics)"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/agent-triggers/{trigger_instance_id}":{"put":{"summary":"Update Workspace Book Connection Agent Trigger Instance","description":"Updates an existing agent trigger instance.\nUses PUT semantics - all fields are required and will replace the existing values.","operationId":"UpdateWorkspaceBookConnectionAgentTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2UpdateWorkspaceBookConnectionAgentTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger_instance_id","description":"The identifier of the agent trigger instance to update","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceUpdateWorkspaceBookConnectionAgentTriggerInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Remove Workspace Book Connection Agent Trigger Instance

> Removes an agent trigger instance from a book connection.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RemoveWorkspaceBookConnectionAgentTriggerInstanceResponse":{"type":"object"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/agent-triggers/{trigger_instance_id}":{"delete":{"summary":"Remove Workspace Book Connection Agent Trigger Instance","description":"Removes an agent trigger instance from a book connection.","operationId":"RemoveWorkspaceBookConnectionAgentTriggerInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RemoveWorkspaceBookConnectionAgentTriggerInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"Book Connection ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger_instance_id","description":"The identifier of the agent trigger instance to remove","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Update Workspace Book Connection Poll Instance

> Updates an existing poll instance's name, configuration, filter expression, and poll interval.\
> Uses PUT semantics - name and configuration replace the existing values.\
> poll\_interval\_minutes is optional; when omitted, the existing interval is preserved.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2UpdateWorkspaceBookConnectionPollInstanceResponse":{"type":"object","properties":{"poll_instance":{"$ref":"#/components/schemas/v2PollInstance"}}},"v2PollInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll instance"},"name":{"type":"string","title":"The name of the poll instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"poll_id":{"type":"string","title":"The identifier of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the poll"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"status":{"$ref":"#/components/schemas/v2PollInstanceStatus"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs associated with this poll instance"},"poll_interval_minutes":{"type":"integer","format":"int64","title":"The poll interval in minutes"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2PollInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2PollInstanceState"},"state_category":{"$ref":"#/components/schemas/v2PollInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"last_checkpoint":{"type":"string","title":"ID of the last processed entry, used to resume polling after restart"}},"title":"Status information for a PollInstance"},"v2PollInstanceState":{"type":"string","enum":["POLL_INSTANCE_STATE_PENDING","POLL_INSTANCE_STATE_READY","POLL_INSTANCE_STATE_FAILED","POLL_INSTANCE_STATE_UNKNOWN"],"default":"POLL_INSTANCE_STATE_PENDING","title":"Possible phases for a PollInstance (Pending, Ready, Failed, Unknown)"},"v2PollInstanceStateCategory":{"type":"string","enum":["POLL_INSTANCE_STATE_CATEGORY_WARNING","POLL_INSTANCE_STATE_CATEGORY_READY","POLL_INSTANCE_STATE_CATEGORY_FAILED"],"default":"POLL_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the poll instance state"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceUpdateWorkspaceBookConnectionPollInstanceBody":{"type":"object","properties":{"name":{"type":"string","title":"The name of the poll instance (required for PUT semantics)"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"description":"Configuration parameters for the poll (required for PUT semantics).\nEmpty map clears the configuration."},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"},"poll_interval_minutes":{"type":"integer","format":"int64","description":"The poll interval in minutes. When absent the existing interval is preserved."}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/polls/{poll_instance_id}":{"put":{"summary":"Update Workspace Book Connection Poll Instance","description":"Updates an existing poll instance's name, configuration, filter expression, and poll interval.\nUses PUT semantics - name and configuration replace the existing values.\npoll_interval_minutes is optional; when omitted, the existing interval is preserved.","operationId":"UpdateWorkspaceBookConnectionPollInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2UpdateWorkspaceBookConnectionPollInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection","in":"path","required":true,"schema":{"type":"string"}},{"name":"poll_instance_id","description":"The identifier of the poll instance to update","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceUpdateWorkspaceBookConnectionPollInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Remove Workspace Book Connection Poll Instance

> Removes a running poll instance.\
> \
> This endpoint gracefully terminates a poll that was previously\
> added via AddWorkspaceBookConnectionPollInstance. The poll will stop\
> monitoring the external system and clean up any resources.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RemoveWorkspaceBookConnectionPollInstanceResponse":{"type":"object"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/polls/{poll_instance_id}":{"delete":{"summary":"Remove Workspace Book Connection Poll Instance","description":"Removes a running poll instance.\n\nThis endpoint gracefully terminates a poll that was previously\nadded via AddWorkspaceBookConnectionPollInstance. The poll will stop\nmonitoring the external system and clean up any resources.","operationId":"RemoveWorkspaceBookConnectionPollInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RemoveWorkspaceBookConnectionPollInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"Book Connection ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"poll_instance_id","description":"The identifier of the poll instance to remove","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Associate Remote Connection

> Associate a remote connection with a book connection.\
> \
> This endpoint adds a label to the book connection to associate it with a remote connection.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceAssociateRemoteConnectionBody":{"type":"object","properties":{"remote_connection_id":{"type":"string","title":"The remote connection id to associate with the book connection"}},"title":"Request to associate a remote connection with a book connection"}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/remote-connection":{"put":{"summary":"Associate Remote Connection","description":"Associate a remote connection with a book connection.\n\nThis endpoint adds a label to the book connection to associate it with a remote connection.","operationId":"AssociateRemoteConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The connection id of the book connection","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceAssociateRemoteConnectionBody"}}},"required":true},"tags":["Books"]}}}}
```

## Disassociate Remote Connection

> Disassociate a remote connection from a book connection.\
> \
> This endpoint removes the remote connection association label from the book connection.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/remote-connection/{remote_connection_id}":{"delete":{"summary":"Disassociate Remote Connection","description":"Disassociate a remote connection from a book connection.\n\nThis endpoint removes the remote connection association label from the book connection.","operationId":"DisassociateRemoteConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The connection id of the book connection","in":"path","required":true,"schema":{"type":"string"}},{"name":"remote_connection_id","description":"The remote connection id to disassociate from the book connection","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Reactivate Workspace Book Connection

> Reactivate a book connection that was scaled to zero due to inactivity.\
> Moves the connection out of the Inactive state so the controller scales its\
> pod back up. Internal services call this over gRPC; the HTTP route is\
> provided so it can also be exposed to users from the UI if desired.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2BookConnectionResponse":{"type":"object","properties":{"book_connection_descriptor":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"authorize_url":{"$ref":"#/components/schemas/v2BookConnectionOAuthURLResponse"}},"title":"The response to an add/update book connection request"},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"v2BookConnectionOAuthURLResponse":{"type":"object","properties":{"url":{"type":"string","title":"The URL to kick off the OAuth flow. It contains:\n- The authorize endpoint\n- The state\n- The scope\n- The redirect uri"}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceReactivateWorkspaceBookConnectionBody":{"type":"object","description":"Request to reactivate a book connection that was scaled to zero due to\ninactivity. Moves the connection out of the Inactive state so the controller\nscales its pod back up."}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}:reactivate":{"post":{"summary":"Reactivate Workspace Book Connection","description":"Reactivate a book connection that was scaled to zero due to inactivity.\nMoves the connection out of the Inactive state so the controller scales its\npod back up. Internal services call this over gRPC; the HTTP route is\nprovided so it can also be exposed to users from the UI if desired.","operationId":"ReactivateWorkspaceBookConnection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BookConnectionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","description":"The identifier of the book connection to reactivate","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceReactivateWorkspaceBookConnectionBody"}}},"required":true},"tags":["Books"]}}}}
```

## Retrieve Workspace Book Connections By Ids

> Retrieve multiple book connections by id in one call.\
> \
> This endpoint is designed to avoid LISTing all connections in a workspace\
> when the caller already knows the specific connection IDs it needs.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveBooksConnectionsResponse":{"type":"object","properties":{"book_connections":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionDescriptor"},"title":"The list of book connections"},"next_page_token":{"type":"string","description":"The token to use to retrieve the next page of connections."}}},"v2BookConnectionDescriptor":{"type":"object","properties":{"book_name":{"type":"string","title":"The name of the book"},"book_version":{"type":"string","title":"The version of the book"},"connection_id":{"type":"string","title":"The connection id of the book"},"connection_name":{"type":"string","title":"The connection name"},"authentication":{"$ref":"#/components/schemas/v2Authentication"},"config":{"type":"array","items":{"$ref":"#/components/schemas/v2ConceptValue"},"title":"Input config concepts. Note: replaced by config_map"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Label"},"title":"Labels associated with the connection"},"status":{"$ref":"#/components/schemas/v2BookConnectionStatus"},"endpoint":{"type":"string","title":"The endpoint of the connection"},"discovered":{"type":"array","items":{"type":"string"},"title":"The list of things that have been discovered"},"config_map":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkV2Value"},"title":"Configured values"},"associated_remote_connection_id":{"type":"string","title":"The id of the associated remote connection"},"shared":{"type":"boolean","title":"True when this connection is shared with every workspace, and so cannot be modified"},"credentials_id":{"type":"string","title":"Managed secret store name backing this connection's credential"},"auto_upgrade":{"type":"boolean","description":"True when the controller may automatically upgrade this connection to newer\nnon-breaking (same major) versions of the book. Defaults to true."}}},"v2Authentication":{"type":"object","properties":{"authentication_id":{"type":"string","title":"Identifier of the authentication method to be used for testing the connection"},"authentication_credentials":{"type":"array","items":{"$ref":"#/components/schemas/v2CredentialValue"},"title":"Credentials"}}},"v2CredentialValue":{"type":"object","properties":{"id":{"type":"string","title":"Id of the credential"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2ConceptValue":{"type":"object","properties":{"noun_phrases":{"$ref":"#/components/schemas/v2NounPhrases"},"value":{"$ref":"#/components/schemas/bdkV2Value"}}},"v2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"}}}},"bdkV2Label":{"type":"object","properties":{"key":{"type":"string","title":"The key of the key-value pair"},"value":{"type":"string","title":"The value of the key-value pair"}}},"v2BookConnectionStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2BookConnectionState"},"state_category":{"$ref":"#/components/schemas/v2BookConnectionStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/v2BookConnectionCondition"},"title":"List of conditions that apply to the BookConnection"}},"title":"Status information for a BookConnection"},"v2BookConnectionState":{"type":"string","enum":["BOOK_CONNECTION_STATE_PENDING","BOOK_CONNECTION_STATE_READY","BOOK_CONNECTION_STATE_FAILED","BOOK_CONNECTION_STATE_CONDITIONS_NOT_MET","BOOK_CONNECTION_STATE_UNKNOWN","BOOK_CONNECTION_STATE_INACTIVE"],"default":"BOOK_CONNECTION_STATE_PENDING","title":"Possible phases for a BookConnection (Pending, ConditionsNotMet, Ready, Failed, Unknown, Inactive)","description":"- BOOK_CONNECTION_STATE_INACTIVE: Scaled to zero due to inactivity; kept for on-demand reactivation."},"v2BookConnectionStateCategory":{"type":"string","enum":["BOOK_CONNECTION_STATE_CATEGORY_WARNING","BOOK_CONNECTION_STATE_CATEGORY_READY","BOOK_CONNECTION_STATE_CATEGORY_FAILED"],"default":"BOOK_CONNECTION_STATE_CATEGORY_WARNING","title":"The category/level of the connection state"},"v2BookConnectionCondition":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/v2BookConnectionConditionType"},"status":{"$ref":"#/components/schemas/v2BookConnectionConditionStatus"},"last_transition_time":{"type":"string","title":"RFC 3339 timestamp of when this condition was last updated"},"reason":{"type":"string","title":"Brief reason explaining the condition"},"reason_code":{"$ref":"#/components/schemas/v2BookConnectionConditionReasonCode"}},"title":"Condition information for BookConnection"},"v2BookConnectionConditionType":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","BOOK_CONNECTION_CONDITION_TYPE_AUTHENTICATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_CONFIGURATION_VALID","BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY","BOOK_CONNECTION_CONDITION_TYPE_CREDENTIALS_VALID","BOOK_CONNECTION_CONDITION_TYPE_DISCOVER_READY","BOOK_CONNECTION_CONDITION_TYPE_TRIGGER_INSTANCES_READY","BOOK_CONNECTION_CONDITION_TYPE_COMPATIBLE_RUNTIME_VERSION","BOOK_CONNECTION_CONDITION_TYPE_POLL_INSTANCES_READY"],"default":"BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID","description":"Represents the various condition types that can be associated with a BookConnection.\n\nConditions are categorized into two groups:\n\n1. [Static Conditions] These conditions are determined solely by the BookConnection's data structure\n   and configuration, and they can be validated without external dependencies or runtime state:\n   - BOOK_VALID\n   - AUTHENTICATION_VALID\n   - CONFIGURATION_VALID\n\n2. [Dynamic Conditions] These conditions depend on external factors and runtime state that can change\n   independently of the BookConnection spec. They require active monitoring and periodic re-evaluation:\n   - DEPLOYMENT_READY\n   - CREDENTIALS_VALID\n   - DISCOVER_READY\n   - TRIGGER_INSTANCES_READY\n   - COMPATIBLE_RUNTIME_VERSION\n   - POLL_INSTANCES_READY\n\n - BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID: Static\n - BOOK_CONNECTION_CONDITION_TYPE_DEPLOYMENT_READY: Dynamic"},"v2BookConnectionConditionStatus":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_STATUS_TRUE","BOOK_CONNECTION_CONDITION_STATUS_FALSE","BOOK_CONNECTION_CONDITION_STATUS_UNKNOWN","BOOK_CONNECTION_CONDITION_STATUS_PENDING"],"default":"BOOK_CONNECTION_CONDITION_STATUS_TRUE","description":"Possible Values:\n - True: All good\n - False: An error occurred\n - Unknown: Condition not applicable/relevant\n - Pending: Underlying process (upon which the condition depends) still ongoing","title":"Status values for conditions"},"v2BookConnectionConditionReasonCode":{"type":"string","enum":["BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_MISSING_IMAGE","BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_RUNTIME_VERSION_OUTDATED","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_MISSING_CREDENTIAL","BOOK_CONNECTION_CONDITION_REASON_CODE_WRONG_CREDENTIAL_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_NOT_FOUND","BOOK_CONNECTION_CONDITION_REASON_CODE_SECRET_MISSING_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_REQUIRED_MISSING","BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_TEST_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_TOKEN_REFRESH_FAILED","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY","BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_WRONG_TYPE","BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO","BOOK_CONNECTION_CONDITION_REASON_CODE_NEW_DEPLOYMENT_ROLLED_OUT","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS","BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_FAILED"],"default":"BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED","description":"- BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED: Book related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_AUTHENTICATION_ID_NOT_FOUND: Authentication related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_CONFIGURATION_UNKNOWN_KEY: Configuration related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_REPLICA_COUNT_IS_ZERO: Connection related\n - BOOK_CONNECTION_CONDITION_REASON_CODE_DISCOVER_IN_PROGRESS: Discover related","title":"Machine-readable reason codes for condition transitions"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceRetrieveWorkspaceBookConnectionsByIdsBody":{"type":"object","properties":{"connection_ids":{"type":"array","items":{"type":"string"},"description":"The list of connection ids to retrieve."}},"description":"Retrieve multiple workspace book connections by their connection IDs.\n\nThis is intended as a batch-get API for clients (e.g. Grimoire) that already\nknow the specific connection_id values they need, and want to avoid the\nLIST-based RetrieveAllWorkspaceBookConnections hot path."}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections:batchGet":{"post":{"summary":"Retrieve Workspace Book Connections By Ids","description":"Retrieve multiple book connections by id in one call.\n\nThis endpoint is designed to avoid LISTing all connections in a workspace\nwhen the caller already knows the specific connection IDs it needs.","operationId":"RetrieveWorkspaceBookConnectionsByIds","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveBooksConnectionsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceRetrieveWorkspaceBookConnectionsByIdsBody"}}},"required":true},"tags":["Books"]}}}}
```

## Retrieve Workspace Poll Instances

> Retrieve all poll instances for a workspace

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2RetrieveWorkspacePollInstancesResponse":{"type":"object","properties":{"poll_instances":{"type":"array","items":{"$ref":"#/components/schemas/v2PollInstance"},"title":"The poll instances"}}},"v2PollInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll instance"},"name":{"type":"string","title":"The name of the poll instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"poll_id":{"type":"string","title":"The identifier of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the poll"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"status":{"$ref":"#/components/schemas/v2PollInstanceStatus"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs associated with this poll instance"},"poll_interval_minutes":{"type":"integer","format":"int64","title":"The poll interval in minutes"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2PollInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2PollInstanceState"},"state_category":{"$ref":"#/components/schemas/v2PollInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"last_checkpoint":{"type":"string","title":"ID of the last processed entry, used to resume polling after restart"}},"title":"Status information for a PollInstance"},"v2PollInstanceState":{"type":"string","enum":["POLL_INSTANCE_STATE_PENDING","POLL_INSTANCE_STATE_READY","POLL_INSTANCE_STATE_FAILED","POLL_INSTANCE_STATE_UNKNOWN"],"default":"POLL_INSTANCE_STATE_PENDING","title":"Possible phases for a PollInstance (Pending, Ready, Failed, Unknown)"},"v2PollInstanceStateCategory":{"type":"string","enum":["POLL_INSTANCE_STATE_CATEGORY_WARNING","POLL_INSTANCE_STATE_CATEGORY_READY","POLL_INSTANCE_STATE_CATEGORY_FAILED"],"default":"POLL_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the poll instance state"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/polls":{"get":{"summary":"Retrieve Workspace Poll Instances","description":"Retrieve all poll instances for a workspace","operationId":"RetrieveWorkspacePollInstances","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2RetrieveWorkspacePollInstancesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 Filter expression\nhttps://google.aip.dev/160","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```

## Set Automations For Poll Instance

> Attach automations to a poll instance.\
> The caller sends the full desired list; the existing list is replaced.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v2SetAutomationsForPollInstanceResponse":{"type":"object","properties":{"poll_instance":{"$ref":"#/components/schemas/v2PollInstance"}}},"v2PollInstance":{"type":"object","properties":{"id":{"type":"string","title":"The identifier of the poll instance"},"name":{"type":"string","title":"The name of the poll instance"},"book_name":{"type":"string","title":"The name of the book"},"connection_id":{"type":"string","title":"The identifier of the book connection"},"poll_id":{"type":"string","title":"The identifier of the poll"},"configuration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/bdkv2Value"},"title":"Configuration parameters for the poll"},"workspace_id":{"type":"string","title":"Workspace ID"},"organization_id":{"type":"string","title":"Organization ID"},"status":{"$ref":"#/components/schemas/v2PollInstanceStatus"},"automation_ids":{"type":"array","items":{"type":"string"},"title":"Automation IDs associated with this poll instance"},"poll_interval_minutes":{"type":"integer","format":"int64","title":"The poll interval in minutes"},"filter_expression":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/bdkv2Date"},"time_value":{"$ref":"#/components/schemas/bdkv2Time"},"file_value":{"$ref":"#/components/schemas/bdkv2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/bdkv2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkv2ListValue"},"opaque_value":{"$ref":"#/components/schemas/bdkv2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/bdkv2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/bdkv2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"bdkv2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"bdkv2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"bdkv2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"bdkv2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2File"}},"title":"A file value represents a file that can be either inline or remote"},"bdkv2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkv2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"bdkv2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkv2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"bdkv2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"},"title":"Is a replationships for the opaque"}}},"bdkv2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkv2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"bdkv2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"bdkv2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2Value"}},"name":{"type":"string"}}},"bdkv2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkv2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableTextValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"type":"string"}},"title":"A text value that can be either inline or stored remotely"},"v2OffloadableDictionaryValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2DictionaryValue"}},"title":"A dictionary value that can be either inline or stored remotely"},"v2DictionaryValue":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v2DictionaryValueField"},"title":"All the fields alongside their values in the dictionary"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the dictionary"}},"title":"Value to be used when the type is dictionary"},"v2DictionaryValueField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"Each key-value pair inside a dictionary"},"bdkV2Value":{"type":"object","properties":{"null_value":{"type":"string"},"conceptual_value":{"$ref":"#/components/schemas/v2NounPhrase"},"text_value":{"type":"string","title":"deprecated: use offloadable_text_value (15) for new code"},"number_value":{"type":"number","format":"double"},"boolean_value":{"type":"boolean"},"datetime_value":{"type":"string","format":"date-time"},"date_value":{"$ref":"#/components/schemas/v2Date"},"time_value":{"$ref":"#/components/schemas/v2Time"},"file_value":{"$ref":"#/components/schemas/v2FileValue"},"dictionary_value":{"$ref":"#/components/schemas/v2DictionaryValue"},"list_value":{"$ref":"#/components/schemas/bdkV2ListValue"},"opaque_value":{"$ref":"#/components/schemas/v2OpaqueValue"},"table_value":{"$ref":"#/components/schemas/v2TableValue"},"sensitive_value":{"$ref":"#/components/schemas/v2SensitiveValue"},"offloadable_text_value":{"$ref":"#/components/schemas/v2OffloadableTextValue"},"offloadable_dictionary_value":{"$ref":"#/components/schemas/v2OffloadableDictionaryValue"},"offloadable_list_value":{"$ref":"#/components/schemas/v2OffloadableListValue"}},"title":"A union of all possible values"},"v2NounPhrase":{"type":"object","properties":{"modifiers":{"type":"array","items":{"type":"string"},"title":"Optional adjectives attached to the noun"},"head":{"type":"string","title":"Noun of the phrase"}}},"v2Date":{"type":"object","properties":{"year":{"type":"integer","format":"int32","title":"Year of the date"},"month":{"type":"integer","format":"int32","title":"Month of a year"},"day":{"type":"integer","format":"int32","title":"Day of a month"}}},"v2Time":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","title":"Hours of day"},"minutes":{"type":"integer","format":"int32","title":"Minutes of hour of day"},"seconds":{"type":"integer","format":"int32","title":"Seconds of minutes of the time"},"nanos":{"type":"integer","format":"int32","title":"Fractions of seconds in nanoseconds"}}},"v2FileValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2File"}},"title":"A file value represents a file that can be either inline or remote"},"v2File":{"type":"object","properties":{"file_name":{"type":"string","title":"The name of the file"},"content":{"type":"string","format":"byte","title":"Content of the file as a byte stream"}}},"bdkV2ListValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"},"title":"All the values inside the list"}},"title":"A collection of values"},"v2OpaqueValue":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"Content of the opaque value"},"is_a":{"type":"array","items":{"$ref":"#/components/schemas/v2NounPhrase"},"title":"Is a replationships for the opaque"}}},"v2TableValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/v2Table"}},"title":"A table that is represented remote as an URL to a file that is Feather-formatted\nor inline via the Table message"},"v2Table":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/v2Column"}}},"description":"A table is a column-oriented structure. All the values inside each column must\nbe of equal length."},"v2Column":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/bdkV2Value"}},"name":{"type":"string"}}},"v2SensitiveValue":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/bdkV2Value"}},"title":"A sensitive value is any value marked as sensitive (to prevent exposure)"},"v2OffloadableListValue":{"type":"object","properties":{"remote":{"type":"string"},"inline":{"$ref":"#/components/schemas/bdkV2ListValue"}},"title":"A list value that can be either inline or stored remotely"},"v2PollInstanceStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/v2PollInstanceState"},"state_category":{"$ref":"#/components/schemas/v2PollInstanceStateCategory"},"reason":{"type":"string","title":"Human-readable message providing additional details about the current state"},"last_updated":{"type":"string","title":"RFC 3339 timestamp of when the status was last updated"},"last_checkpoint":{"type":"string","title":"ID of the last processed entry, used to resume polling after restart"}},"title":"Status information for a PollInstance"},"v2PollInstanceState":{"type":"string","enum":["POLL_INSTANCE_STATE_PENDING","POLL_INSTANCE_STATE_READY","POLL_INSTANCE_STATE_FAILED","POLL_INSTANCE_STATE_UNKNOWN"],"default":"POLL_INSTANCE_STATE_PENDING","title":"Possible phases for a PollInstance (Pending, Ready, Failed, Unknown)"},"v2PollInstanceStateCategory":{"type":"string","enum":["POLL_INSTANCE_STATE_CATEGORY_WARNING","POLL_INSTANCE_STATE_CATEGORY_READY","POLL_INSTANCE_STATE_CATEGORY_FAILED"],"default":"POLL_INSTANCE_STATE_CATEGORY_WARNING","title":"The category/level of the poll instance state"},"bdkv2Expression":{"type":"object","properties":{"binary_expression":{"$ref":"#/components/schemas/bdkv2BinaryExpression"},"unary_expression":{"$ref":"#/components/schemas/bdkv2UnaryExpression"},"value_expression":{"$ref":"#/components/schemas/bdkv2Value"},"noun_phrases_expression":{"$ref":"#/components/schemas/bdkv2NounPhrases"}}},"bdkv2BinaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2BinaryOperator"},"left":{"$ref":"#/components/schemas/bdkv2Expression"},"right":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2BinaryOperator":{"type":"string","enum":["BinaryOperatorAnd","BinaryOperatorOr","BinaryOperatorEquals","BinaryOperatorNotEquals","BinaryOperatorIn","BinaryOperatorHas","BinaryOperatorLessThan","BinaryOperatorGreaterThan","BinaryOperatorLessThanOrEqual","BinaryOperatorGreaterThanOrEqual"],"default":"BinaryOperatorAnd"},"bdkv2UnaryExpression":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/bdkv2UnaryOperator"},"inner":{"$ref":"#/components/schemas/bdkv2Expression"}}},"bdkv2UnaryOperator":{"type":"string","enum":["UnaryOperatorNot","UnaryOperatorExists"],"default":"UnaryOperatorNot"},"bdkv2NounPhrases":{"type":"object","properties":{"noun_phrases":{"type":"array","items":{"$ref":"#/components/schemas/bdkv2NounPhrase"}}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"LibraryServiceSetAutomationsForPollInstanceBody":{"type":"object","properties":{"automation_ids":{"type":"array","items":{"type":"string"},"title":"The identifiers of the automations to attach to the poll instance"},"connection_id":{"type":"string","title":"The id of the book connection"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/polls/{poll_instance_id}/automations":{"put":{"summary":"Set Automations For Poll Instance","description":"Attach automations to a poll instance.\nThe caller sends the full desired list; the existing list is replaced.","operationId":"SetAutomationsForPollInstance","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2SetAutomationsForPollInstanceResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"The id of the organization","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"The id of the workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"poll_instance_id","description":"The identifier of the poll instance","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryServiceSetAutomationsForPollInstanceBody"}}},"required":true},"tags":["Books"]}}}}
```

## Retrieve Workspace Tags

> Retrieves all available tags from books visible in a workspace.\
> \
> This endpoint returns a consolidated list of all tags used across the books\
> visible in the workspace context (global library + workspace-private books).

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Books","description":"Browse and search books, concepts, procedures, connections, and triggers."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"bdkv2RetrieveTagsResponse":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"title":"Tags"}},"title":"Response to retrieve tags"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/tags":{"get":{"summary":"Retrieve Workspace Tags","description":"Retrieves all available tags from books visible in a workspace.\n\nThis endpoint returns a consolidated list of all tags used across the books\nvisible in the workspace context (global library + workspace-private books).","operationId":"RetrieveWorkspaceTags","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bdkv2RetrieveTagsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Organization identifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","description":"Workspace identifier","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Books"]}}}}
```
