Books
Authorizations
AuthorizationstringRequired
Personal Access Token.
Query parameters
page_sizeinteger · int32Optional
The maximum number of books to return.
page_tokenstringOptional
The token to use to retrieve the next page of books.
filterstringOptional
AIP-160 Filter expression https://google.aip.dev/160
Responses
200
A successful response.
application/json
next_page_tokenstringOptional
The token to use to retrieve the next page of books.
default
An unexpected error response.
application/json
get/api/v1/books
GET /api/v1/books HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"books": [
{
"id": "text",
"name": "text",
"short_description": "text",
"long_description": "text",
"author": "text",
"icon": "Ynl0ZXM=",
"version": "text",
"authentications": [
{
"custom": {
"id": "text",
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"description": "text",
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"preferred": true
},
"oauth": {
"id": "text",
"provider": "OAuthProviderMicrosoft",
"flows": [
"OAuthFlowAuthorizationCode"
],
"authorize_endpoint": "text",
"token_endpoint": "text",
"scope": [
"text"
],
"name": "text",
"arguments": [
{
"id": "text",
"name": "text",
"description": "text"
}
],
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"preferred": true
}
}
],
"configurations": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"display_name": "text",
"endpoint": "text",
"connection_required": true,
"discover_capable": true,
"tags": [
"text"
],
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
"[Circular Reference]"
],
"outputs": [
"[Circular Reference]"
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
"[Circular Reference]"
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
],
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"userinfo_capable": true,
"triggers": [
{
"id": "text",
"name": "text",
"description": "text",
"setup_description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"filter_capable": true,
"is_manual": true,
"event_type": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"is_shared_endpoint": true
}
],
"bdk_runtime_version": "text",
"environment_information": {
"version": "text",
"runtime_name": "text",
"runtime_version": "text",
"bci_protocol_version": "text",
"api_version": "text",
"path": [
"text"
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
},
"hidden": true,
"polls": [
{
"id": "text",
"name": "text",
"description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"stop_function_name": "text",
"output_concept": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
}
]
}
],
"next_page_token": "text"
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
namestringRequired
versionstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/books/{name}/{version}
GET /api/v1/books/{name}/{version} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"book": {
"id": "text",
"name": "text",
"short_description": "text",
"long_description": "text",
"author": "text",
"icon": "Ynl0ZXM=",
"version": "text",
"authentications": [
{
"custom": {
"id": "text",
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"description": "text",
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"preferred": true
},
"oauth": {
"id": "text",
"provider": "OAuthProviderMicrosoft",
"flows": [
"OAuthFlowAuthorizationCode"
],
"authorize_endpoint": "text",
"token_endpoint": "text",
"scope": [
"text"
],
"name": "text",
"arguments": [
{
"id": "text",
"name": "text",
"description": "text"
}
],
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"preferred": true
}
}
],
"configurations": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"display_name": "text",
"endpoint": "text",
"connection_required": true,
"discover_capable": true,
"tags": [
"text"
],
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]"
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
],
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"userinfo_capable": true,
"triggers": [
{
"id": "text",
"name": "text",
"description": "text",
"setup_description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"filter_capable": true,
"is_manual": true,
"event_type": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"is_shared_endpoint": true
}
],
"bdk_runtime_version": "text",
"environment_information": {
"version": "text",
"runtime_name": "text",
"runtime_version": "text",
"bci_protocol_version": "text",
"api_version": "text",
"path": [
"text"
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"hidden": true,
"polls": [
{
"id": "text",
"name": "text",
"description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"stop_function_name": "text",
"output_concept": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
}
]
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
namestringRequired
versionstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/books/{name}/{version}/procedures
GET /api/v1/books/{name}/{version}/procedures HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Responses
200
A successful response.
application/json
tagsstring[]Optional
default
An unexpected error response.
application/json
get/api/v1/tags
GET /api/v1/tags HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"tags": [
"text"
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Query parameters
page_sizeinteger · int32Optional
The maximum number of books to return.
page_tokenstringOptional
The token to use to retrieve the next page of books.
filterstringOptional
AIP-160 Filter expression https://google.aip.dev/160
Responses
200
A successful response.
application/json
next_page_tokenstringOptional
The token to use to retrieve the next page of books.
default
An unexpected error response.
application/json
get/api/v1/books:latest
GET /api/v1/books:latest HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"books": [
{
"id": "text",
"name": "text",
"short_description": "text",
"long_description": "text",
"author": "text",
"icon": "Ynl0ZXM=",
"version": "text",
"authentications": [
{
"custom": {
"id": "text",
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"description": "text",
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"preferred": true
},
"oauth": {
"id": "text",
"provider": "OAuthProviderMicrosoft",
"flows": [
"OAuthFlowAuthorizationCode"
],
"authorize_endpoint": "text",
"token_endpoint": "text",
"scope": [
"text"
],
"name": "text",
"arguments": [
{
"id": "text",
"name": "text",
"description": "text"
}
],
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"preferred": true
}
}
],
"configurations": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"display_name": "text",
"endpoint": "text",
"connection_required": true,
"discover_capable": true,
"tags": [
"text"
],
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
"[Circular Reference]"
],
"outputs": [
"[Circular Reference]"
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
"[Circular Reference]"
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
],
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"userinfo_capable": true,
"triggers": [
{
"id": "text",
"name": "text",
"description": "text",
"setup_description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"filter_capable": true,
"is_manual": true,
"event_type": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"is_shared_endpoint": true
}
],
"bdk_runtime_version": "text",
"environment_information": {
"version": "text",
"runtime_name": "text",
"runtime_version": "text",
"bci_protocol_version": "text",
"api_version": "text",
"path": [
"text"
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
},
"hidden": true,
"polls": [
{
"id": "text",
"name": "text",
"description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"stop_function_name": "text",
"output_concept": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
}
]
}
],
"next_page_token": "text"
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
namestringRequired
Responses
200
A successful response.
application/json
versionsstring[]Optional
default
An unexpected error response.
application/json
get/api/v1/books/{name}/versions
GET /api/v1/books/{name}/versions HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"versions": [
"text"
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
namestringRequired
versionstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/books/{name}/{version}/concepts
GET /api/v1/books/{name}/{version}/concepts HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"concepts": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": [
"[Circular Reference]"
],
"description": "text"
},
"table_type": {
"columns": [
"[Circular Reference]"
],
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": [
"[Circular Reference]"
]
},
"self_type": {},
"sensitive_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": [
"[Circular Reference]"
],
"description": "text"
},
"table_type": {
"columns": [
"[Circular Reference]"
],
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": [
"[Circular Reference]"
]
},
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
}
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
Query parameters
page_sizeinteger · int32Optional
The maximum number of books to return.
page_tokenstringOptional
The token to use to retrieve the next page of books.
Responses
200
A successful response.
application/json
next_page_tokenstringOptional
The token to use to retrieve the next page of books.
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"books": [
{
"id": "text",
"name": "text",
"short_description": "text",
"long_description": "text",
"author": "text",
"icon": "Ynl0ZXM=",
"version": "text",
"authentications": [
{
"custom": {
"id": "text",
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"description": "text",
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"preferred": true
},
"oauth": {
"id": "text",
"provider": "OAuthProviderMicrosoft",
"flows": [
"OAuthFlowAuthorizationCode"
],
"authorize_endpoint": "text",
"token_endpoint": "text",
"scope": [
"text"
],
"name": "text",
"arguments": [
{
"id": "text",
"name": "text",
"description": "text"
}
],
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"preferred": true
}
}
],
"configurations": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"display_name": "text",
"endpoint": "text",
"connection_required": true,
"discover_capable": true,
"tags": [
"text"
],
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
"[Circular Reference]"
],
"outputs": [
"[Circular Reference]"
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
"[Circular Reference]"
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
],
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"userinfo_capable": true,
"triggers": [
{
"id": "text",
"name": "text",
"description": "text",
"setup_description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"filter_capable": true,
"is_manual": true,
"event_type": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"is_shared_endpoint": true
}
],
"bdk_runtime_version": "text",
"environment_information": {
"version": "text",
"runtime_name": "text",
"runtime_version": "text",
"bci_protocol_version": "text",
"api_version": "text",
"path": [
"text"
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
},
"hidden": true,
"polls": [
{
"id": "text",
"name": "text",
"description": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"stop_function_name": "text",
"output_concept": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
}
]
}
],
"next_page_token": "text"
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
namestringRequired
versionstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}/procedures
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}/procedures HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
namestringRequired
versionstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}/concepts
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{name}/{version}/concepts HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"concepts": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": [
"[Circular Reference]"
],
"description": "text"
},
"table_type": {
"columns": [
"[Circular Reference]"
],
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": [
"[Circular Reference]"
]
},
"self_type": {},
"sensitive_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": [
"[Circular Reference]"
],
"description": "text"
},
"table_type": {
"columns": [
"[Circular Reference]"
],
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": [
"[Circular Reference]"
]
},
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
}
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Query parameters
searchstringOptional
A search term to filter the discoverables
offsetstring · uint64Optional
The starting point within the data set from which records will be returned. Used for pagination.
limitstring · uint64Optional
The maximum number of records to return from the data set. Used for pagination.
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discoverables
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discoverables HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"discoverables": [
{
"name": "text",
"description": "text"
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/procedures:search
POST /api/v1/procedures:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book_name": "text",
"book_version": "text",
"procedure": {
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]"
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
},
"score": 1
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/books:search
POST /api/v1/books:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book": {
"id": "text",
"name": "text",
"short_description": "text",
"long_description": "text",
"author": "text",
"icon": "Ynl0ZXM=",
"version": "text",
"authentications": [
{
"custom": {
"id": "text",
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"description": "text",
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"preferred": true
},
"oauth": {
"id": "text",
"provider": "OAuthProviderMicrosoft",
"flows": [
"OAuthFlowAuthorizationCode"
],
"authorize_endpoint": "text",
"token_endpoint": "text",
"scope": [
"text"
],
"name": "text",
"arguments": [
{
"id": "text",
"name": "text",
"description": "text"
}
],
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"preferred": true
}
}
],
"configurations": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"display_name": "text",
"endpoint": "text",
"connection_required": true,
"discover_capable": true,
"tags": [
"text"
],
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": "[Circular Reference]",
"outputs": "[Circular Reference]",
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": "[Circular Reference]",
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
],
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"userinfo_capable": true,
"triggers": [
{
"id": "text",
"name": "text",
"description": "text",
"setup_description": "text",
"configuration": "[Circular Reference]",
"filter_capable": true,
"is_manual": true,
"event_type": "[Circular Reference]",
"is_shared_endpoint": true
}
],
"bdk_runtime_version": "text",
"environment_information": {
"version": "text",
"runtime_name": "text",
"runtime_version": "text",
"bci_protocol_version": "text",
"api_version": "text",
"path": [
"text"
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
},
"hidden": true,
"polls": [
{
"id": "text",
"name": "text",
"description": "text",
"configuration": "[Circular Reference]",
"stop_function_name": "text",
"output_concept": "[Circular Reference]"
}
]
},
"score": 1
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/concepts:search
POST /api/v1/concepts:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book_name": "text",
"book_version": "text",
"concept": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"score": 1
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/procedures:search
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/procedures:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book_name": "text",
"book_version": "text",
"procedure": {
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]"
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
},
"score": 1,
"organization_id": "text",
"workspace_id": "text",
"connection_id": "text"
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/procedures:search
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/procedures:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book_name": "text",
"book_version": "text",
"procedure": {
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]"
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
},
"score": 1,
"organization_id": "text",
"workspace_id": "text",
"connection_id": "text"
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books:search
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book": {
"id": "text",
"name": "text",
"short_description": "text",
"long_description": "text",
"author": "text",
"icon": "Ynl0ZXM=",
"version": "text",
"authentications": [
{
"custom": {
"id": "text",
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"description": "text",
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"preferred": true
},
"oauth": {
"id": "text",
"provider": "OAuthProviderMicrosoft",
"flows": [
"OAuthFlowAuthorizationCode"
],
"authorize_endpoint": "text",
"token_endpoint": "text",
"scope": [
"text"
],
"name": "text",
"arguments": [
{
"id": "text",
"name": "text",
"description": "text"
}
],
"credentials": [
{
"id": "text",
"type": "CredentialTypeText",
"label": "text",
"visible": true,
"description": "text"
}
],
"preferred": true
}
}
],
"configurations": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
],
"display_name": "text",
"endpoint": "text",
"connection_required": true,
"discover_capable": true,
"tags": [
"text"
],
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": "[Circular Reference]",
"outputs": "[Circular Reference]",
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": "[Circular Reference]",
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
],
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"userinfo_capable": true,
"triggers": [
{
"id": "text",
"name": "text",
"description": "text",
"setup_description": "text",
"configuration": "[Circular Reference]",
"filter_capable": true,
"is_manual": true,
"event_type": "[Circular Reference]",
"is_shared_endpoint": true
}
],
"bdk_runtime_version": "text",
"environment_information": {
"version": "text",
"runtime_name": "text",
"runtime_version": "text",
"bci_protocol_version": "text",
"api_version": "text",
"path": [
"text"
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": "[Circular Reference]",
"description": "text",
"default_value": "[Circular Reference]"
}
},
"hidden": true,
"polls": [
{
"id": "text",
"name": "text",
"description": "text",
"configuration": "[Circular Reference]",
"stop_function_name": "text",
"output_concept": "[Circular Reference]"
}
]
},
"score": 1
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
Body
querystringOptional
top_kinteger · int64Optional
max_distancenumber · floatOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/concepts:search
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/concepts:search HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": "text",
"top_k": 1,
"max_distance": 1
}{
"results": [
{
"book_name": "text",
"book_version": "text",
"concept": {
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": {
"inner": "[Circular Reference]"
},
"list_type": {
"inner": "[Circular Reference]"
},
"dictionary_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"fields": "[Circular Reference]",
"description": "text"
},
"table_type": {
"columns": "[Circular Reference]",
"description": "text"
},
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": {
"inners": "[Circular Reference]"
},
"self_type": {},
"sensitive_type": {
"inner": "[Circular Reference]"
},
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"score": 1
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
book_namestringRequired
book_versionstringRequired
Query parameters
page_sizeinteger · int32Optional
The maximum number of connections to return.
page_tokenstringOptional
The token to use to retrieve the next page of connections.
Responses
200
A successful response.
application/json
next_page_tokenstringOptional
The token to use to retrieve the next page of connections.
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"book_connections": [
{
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": "[Circular Reference]"
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
}
],
"next_page_token": "text"
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
book_namestringRequired
book_versionstringRequired
Body
connection_namestringOptional
oauth_flowstring · enumOptionalDefault:
OAuthFlowAuthorizationCodePossible values: Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2095
{
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"labels": [
{
"key": "text",
"value": "text"
}
],
"oauth_flow": "OAuthFlowAuthorizationCode"
}{
"book_connection_descriptor": {
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"authorize_url": {
"url": "text"
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
book_namestringRequired
book_versionstringRequired
connection_idstringRequired
Body
connection_namestringOptional
oauth_flowstring · enumOptionalDefault:
OAuthFlowAuthorizationCodePossible values: Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
put/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}
PUT /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2095
{
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
]
},
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"labels": [
{
"key": "text",
"value": "text"
}
],
"oauth_flow": "OAuthFlowAuthorizationCode"
}{
"book_connection_descriptor": {
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"authorize_url": {
"url": "text"
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"book_connection": {
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
Query parameters
page_sizeinteger · int32Optional
The maximum number of connections to return.
page_tokenstringOptional
The token to use to retrieve the next page of connections.
filterstringOptional
AIP-160 Filtering https://google.aip.dev/160
Responses
200
A successful response.
application/json
next_page_tokenstringOptional
The token to use to retrieve the next page of connections.
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"book_connections": [
{
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": "[Circular Reference]"
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
}
],
"next_page_token": "text"
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
book_namestringRequired
book_versionstringRequired
connection_idstringRequired
Body
new_book_versionstringOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
put/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/upgrade
PUT /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/upgrade HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"new_book_version": "text"
}{
"book_connection_descriptor": {
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"authorize_url": {
"url": "text"
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
put/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/authorize
PUT /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/authorize HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"book_connection_descriptor": {
"book_name": "text",
"book_version": "text",
"connection_id": "text",
"connection_name": "text",
"authentication": {
"authentication_id": "text",
"authentication_credentials": [
{
"id": "text",
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
]
},
"config": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
],
"labels": [
{
"key": "text",
"value": "text"
}
],
"status": {
"state": "BOOK_CONNECTION_STATE_PENDING",
"state_category": "BOOK_CONNECTION_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text",
"conditions": [
{
"type": "BOOK_CONNECTION_CONDITION_TYPE_BOOK_VALID",
"status": "BOOK_CONNECTION_CONDITION_STATUS_TRUE",
"last_transition_time": "text",
"reason": "text",
"reason_code": "BOOK_CONNECTION_CONDITION_REASON_CODE_BOOK_LOOKUP_FAILED"
}
]
},
"endpoint": "text",
"discovered": [
"text"
],
"config_map": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
}
},
"authorize_url": {
"url": "text"
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Body
whatstring[]Optional
Responses
200
A successful response.
application/json
object · A response that is sent to reply to a library discovery requestOptional
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discover
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discover HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"what": [
"text"
]
}{}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/procedures
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/procedures HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"procedures": [
{
"id": "text",
"signature": {
"english": "text",
"verbs": [
"text"
],
"object": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"preposition": "text",
"target": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"outputs": [
{
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
],
"proper_nouns": [
"text"
]
},
"inputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"outputs": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
},
"description": "text",
"default_value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": "[Circular Reference]",
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
}
],
"short_description": "text",
"long_description": "text",
"filter_capable": true,
"page_capable": true,
"connection_required": "Optional",
"is_discovered": true,
"questions": [
{
"noun_phrases": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"type": {
"scalar_type": "ConceptScalarTypeConceptual",
"optional_type": "[Circular Reference]",
"list_type": "[Circular Reference]",
"dictionary_type": "[Circular Reference]",
"table_type": "[Circular Reference]",
"opaque_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"description": "text"
},
"any_type": {},
"union_type": "[Circular Reference]",
"self_type": {},
"sensitive_type": "[Circular Reference]",
"enum_type": {
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
],
"members": [
{
"name": "text",
"noun_phrase": {
"modifiers": [
"text"
],
"head": "text"
},
"description": "text"
}
],
"description": "text"
}
}
}
],
"examples": [
{
"description": "text",
"snippet": "text"
}
],
"is_async": true,
"is_mutation": true,
"search_hints": [
"text"
]
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
book_namestringRequired
book_versionstringRequired
connection_idstringRequired
Body
trigger_idstringOptional
namestringOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/triggers
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/books/{book_name}/{book_version}/connections/{connection_id}/triggers HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13161
{
"trigger_id": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
{
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": [
"[Circular Reference]"
]
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
{
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": [
"[Circular Reference]"
]
}
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"filter_expression": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
{
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": [
"[Circular Reference]"
]
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
{
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": [
"[Circular Reference]"
]
}
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
{
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": [
"[Circular Reference]"
]
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
{
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": "[Circular Reference]",
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": "[Circular Reference]",
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": [
"[Circular Reference]"
]
}
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"name": "text"
}{
"trigger_instance": {
"id": "text",
"name": "text",
"reference": "text",
"book_name": "text",
"connection_id": "text",
"trigger_id": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
}
},
"endpoint": "text",
"automation_ids": [
"text"
],
"workspace_id": "text",
"organization_id": "text",
"filter_expression": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": "[Circular Reference]",
"right": "[Circular Reference]"
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": "[Circular Reference]"
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": "[Circular Reference]",
"right": "[Circular Reference]"
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": "[Circular Reference]"
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": "[Circular Reference]"
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"status": {
"state": "TRIGGER_INSTANCE_STATE_PENDING",
"state_category": "TRIGGER_INSTANCE_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text"
}
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
trigger_instance_idstringRequired
Body
automation_idsstring[]Optional
connection_idstringOptional
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers/{trigger_instance_id}/automations
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers/{trigger_instance_id}/automations HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"automation_ids": [
"text"
],
"connection_id": "text"
}{
"trigger_instance": {
"id": "text",
"name": "text",
"reference": "text",
"book_name": "text",
"connection_id": "text",
"trigger_id": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
}
},
"endpoint": "text",
"automation_ids": [
"text"
],
"workspace_id": "text",
"organization_id": "text",
"filter_expression": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": "[Circular Reference]",
"right": "[Circular Reference]"
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": "[Circular Reference]"
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": "[Circular Reference]",
"right": "[Circular Reference]"
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": "[Circular Reference]"
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": "[Circular Reference]"
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": {
"value": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": [
"[Circular Reference]"
],
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": [
"[Circular Reference]"
]
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": {
"columns": "[Circular Reference]"
}
},
"sensitive_value": "[Circular Reference]",
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": "[Circular Reference]",
"offloadable_list_value": "[Circular Reference]"
}
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"offloadable_list_value": {
"remote": "text",
"inline": {
"values": "[Circular Reference]"
}
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"status": {
"state": "TRIGGER_INSTANCE_STATE_PENDING",
"state_category": "TRIGGER_INSTANCE_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text"
}
}
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
trigger_instance_idstringRequired
Responses
200
A successful response.
application/json
object · v2RemoveWorkspaceBookConnectionTriggerInstanceResponseOptional
default
An unexpected error response.
application/json
delete/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/triggers/{trigger_instance_id}
DELETE /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/triggers/{trigger_instance_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
Query parameters
filterstringOptional
AIP-160 Filter expression https://google.aip.dev/160
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/triggers HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"trigger_instances": [
{
"id": "text",
"name": "text",
"reference": "text",
"book_name": "text",
"connection_id": "text",
"trigger_id": "text",
"configuration": {
"ANY_ADDITIONAL_PROPERTY": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
}
},
"endpoint": "text",
"automation_ids": [
"text"
],
"workspace_id": "text",
"organization_id": "text",
"filter_expression": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": {
"operator": "UnaryOperatorNot",
"inner": {
"binary_expression": {
"operator": "BinaryOperatorAnd",
"left": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"right": {
"binary_expression": "[Circular Reference]",
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"unary_expression": "[Circular Reference]",
"value_expression": "[Circular Reference]",
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
}
},
"value_expression": {
"null_value": "text",
"conceptual_value": {
"modifiers": [
"text"
],
"head": "text"
},
"text_value": "text",
"number_value": 1,
"boolean_value": true,
"datetime_value": "2026-01-01T00:00:00.000Z",
"date_value": {
"year": 1,
"month": 1,
"day": 1
},
"time_value": {
"hours": 1,
"minutes": 1,
"seconds": 1,
"nanos": 1
},
"file_value": {
"remote": "text",
"inline": {
"file_name": "text",
"content": "Ynl0ZXM="
}
},
"dictionary_value": {
"fields": "[Circular Reference]",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"list_value": {
"values": "[Circular Reference]"
},
"opaque_value": {
"content": "Ynl0ZXM=",
"is_a": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
},
"table_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"sensitive_value": {
"value": "[Circular Reference]"
},
"offloadable_text_value": {
"remote": "text",
"inline": "text"
},
"offloadable_dictionary_value": {
"remote": "text",
"inline": "[Circular Reference]"
},
"offloadable_list_value": {
"remote": "text",
"inline": "[Circular Reference]"
}
},
"noun_phrases_expression": {
"noun_phrases": [
{
"modifiers": [
"text"
],
"head": "text"
}
]
}
},
"status": {
"state": "TRIGGER_INSTANCE_STATE_PENDING",
"state_category": "TRIGGER_INSTANCE_STATE_CATEGORY_WARNING",
"reason": "text",
"last_updated": "text"
}
}
]
}Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
connection_idstringRequired
Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/user-info
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/user-info HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"user_info": {
"email": "text",
"username": "text",
"other_attributes": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}Last updated
Was this helpful?