Books

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

View Books

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
              "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"
}

View Book Details

get

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

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
              "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-03-12T11:49:38.504Z",
              "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-03-12T11:49:38.504Z",
              "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-03-12T11:49:38.504Z",
              "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
              "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-03-12T11:49:38.504Z",
            "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]"
            }
          }
        }
      }
    ]
  }
}

View Book Procedures

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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"
      ]
    }
  ]
}

View Tags

get

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Responses

200

A successful response.

application/json

tagsstring[]Optional

default

An unexpected error response.

application/json

get

/api/v1/tags

HTTPcURLJavaScriptPython

GET /api/v1/tags HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tags": [
    "text"
  ]
}

View Latest Books

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
              "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"
}

View Book Versions

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

GET /api/v1/books/{name}/versions HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "versions": [
    "text"
  ]
}

View Book Concepts

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
        "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-03-12T11:49:38.504Z",
            "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]"
          }
        }
      }
    }
  ]
}

View Workspace Books

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
              "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"
}

View Workspace Book Procedures

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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"
      ]
    }
  ]
}

View Workspace Book Concepts

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
        "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-03-12T11:49:38.504Z",
            "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]"
          }
        }
      }
    }
  ]
}

View Connection Discoverables

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Search Book Procedures

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Body

application/json

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

HTTPcURLJavaScriptPython

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
    }
  ]
}

Search Books

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Body

application/json

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

HTTPcURLJavaScriptPython

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
    }
  ]
}

Search Book Concepts

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Body

application/json

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
          "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
    }
  ]
}

Search Workspace Book Procedures

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Search Connection Procedures

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

connection_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Search Workspace Books

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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
    }
  ]
}

Search Workspace Book Concepts

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
          "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
    }
  ]
}

View Book Connections

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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"
}

Create Book Connection

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

book_namestringRequired

book_versionstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
      "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
        "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"
  }
}

Update Book Connection

put

This endpoint updates a book connection in the library.

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

book_namestringRequired

book_versionstringRequired

connection_idstringRequired

Body

application/json

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}

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
      "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
        "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"
  }
}

View Connection

get

This endpoint returns a specific book connection.

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
        "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]"
        }
      }
    }
  }
}

View All Connections

get

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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"
}

Upgrade Book Connection

put

This endpoint upgrades a book connection to a new version.

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

book_namestringRequired

book_versionstringRequired

connection_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
        "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"
  }
}

Authorize Connection

put

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
        "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"
  }
}

Discover Connection Procedures

post

This endpoint allows books to discover and register new procedures at runtime by connecting to external APIs, databases, or services. The discovered procedures become available for invocation.

Supports:

• Specification of what entities to discover

• Dynamic procedure registration

Note: This will override any existing discoverables, and sending an empty list will remove all discoverables.

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

connection_idstringRequired

Body

application/json

whatstring[]Optional

Responses

200

A successful response.

application/json

object · AresponsethatissenttoreplytoalibrarydiscoveryrequestOptional

default

An unexpected error response.

application/json

post

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/discover

HTTPcURLJavaScriptPython

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"
  ]
}

{}

View Connection Procedures

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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"
      ]
    }
  ]
}

Create Trigger Instance

post

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

book_namestringRequired

book_versionstringRequired

connection_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
      "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
              "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-03-12T11:49:38.504Z",
                    "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-03-12T11:49:38.504Z",
      "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
        "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
        "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-03-12T11:49:38.504Z",
            "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"
    }
  }
}

Set Trigger Automations

post

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

trigger_instance_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
        "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
            "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-03-12T11:49:38.504Z",
                "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-03-12T11:49:38.504Z",
        "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-03-12T11:49:38.504Z",
            "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"
    }
  }
}

Delete Trigger Instance

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

connection_idstringRequired

trigger_instance_idstringRequired

Responses

200

A successful response.

application/json

objectOptional

default

An unexpected error response.

application/json

delete

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/connections/{connection_id}/triggers/{trigger_instance_id}

HTTPcURLJavaScriptPython

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: */*

{}

View Trigger Instances

get

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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-03-12T11:49:38.504Z",
          "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-03-12T11:49:38.504Z",
          "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"
      }
    }
  ]
}

View Connection User Info

get

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

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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"
    }
  }
}