api.md

Whitelabel

Types:

from structify.types import EstimateCostResponse

Methods:

client.whitelabel.estimate_cost(path, *, service) -> EstimateCostResponse
client.whitelabel.proxy_get(path, *, service) -> None
client.whitelabel.proxy_post(path, *, service) -> None

User

Types:

from structify.types import (
    EnrichUserParams,
    GetOnboardingAnswersResponse,
    JwtToAPITokenRequest,
    OnboardingAnswers,
    RefreshSessionRequest,
    RefreshSessionResponse,
    SaveOnboardingAnswersRequest,
    SaveOnboardingAnswersResponse,
    SurveySubmissionRequest,
    SurveySubmissionResponse,
    TokenResponse,
    UpdateUserParams,
    UserInfo,
    UserTransactionsResponse,
    UserUsageResponse,
)

Methods:

client.user.update(**params) -> User
client.user.enrich(**params) -> None
client.user.get_onboarding_answers() -> GetOnboardingAnswersResponse
client.user.info() -> UserInfo
client.user.refresh(**params) -> RefreshSessionResponse
client.user.save_onboarding_answers(**params) -> SaveOnboardingAnswersResponse
client.user.survey_submit(**params) -> SurveySubmissionResponse
client.user.transactions() -> UserTransactionsResponse
client.user.usage(**params) -> UserUsageResponse

Stripe

Types:

from structify.types.user import (
    CreatePortalRequest,
    CreateSessionRequest,
    CreateSessionResponse,
    CreateSubscriptionRequest,
    SubscriptionPlan,
)

Methods:

client.user.stripe.create_portal_session(**params) -> CreateSessionResponse
client.user.stripe.create_session(**params) -> CreateSessionResponse
client.user.stripe.create_subscription(**params) -> CreateSessionResponse

APIKeys

Types:

from structify.types.user import (
    APIKeyInfo,
    CreateAPIKeyRequest,
    CreateAPIKeyResponse,
    ListAPIKeysResponse,
)

Methods:

client.user.api_keys.create(**params) -> CreateAPIKeyResponse
client.user.api_keys.list() -> ListAPIKeysResponse
client.user.api_keys.get(id) -> APIKeyInfo
client.user.api_keys.revoke(id) -> None

Chat

Types:

from structify.types import (
    AddCollaboratorRequest,
    AdminGrantAccessResponse,
    AdminIssueFoundRequest,
    AdminIssueFoundResponse,
    ChatDependency,
    ChatEvent,
    ChatSession,
    ChatSessionRole,
    ChatSessionUser,
    ChatSessionWithMessages,
    ChatTemplate,
    ChatVisibility,
    CompressChatResponse,
    CopyChatSessionRequest,
    CreateChatSessionRequest,
    CreateChatSessionResponse,
    DashboardItem,
    DeleteChatSessionResponse,
    ErrorResponse,
    GetChatSessionResponse,
    GetDependenciesResponse,
    GrantAdminAccessRequest,
    ListChatSessionsResponse,
    ListCollaboratorsResponse,
    ListDashboardsResponse,
    Message,
    SimulatePromptRequest,
    SimulatePromptResponse,
    TemplateQuestion,
    ToolInvocation,
    ToolResult,
    UpdateChatSessionFavoriteRequest,
    UpdateChatSessionRequest,
    UpdateVisibilityRequest,
    UpdateVisibilityResponse,
    ChatAddGitCommitResponse,
    ChatCopyNodeOutputByCodeHashResponse,
    ChatDeleteInputFileResponse,
    ChatGetGitCommitResponse,
    ChatGetPartialChatsResponse,
    ChatGetSessionTimelineResponse,
    ChatListInputFilesResponse,
    ChatListTemplatesResponse,
    ChatLoadFilesResponse,
    ChatLoadInputFilesResponse,
    ChatRevertToCommitResponse,
    ChatUploadInputFileResponse,
)

Methods:

client.chat.add_collaborator(chat_id, **params) -> None
client.chat.add_git_commit(session_id, **params) -> ChatAddGitCommitResponse
client.chat.admin_issue_found(chat_id, **params) -> AdminIssueFoundResponse
client.chat.compress(session_id) -> CompressChatResponse
client.chat.copy(**params) -> ChatSessionWithMessages
client.chat.copy_node_output_by_code_hash(session_id, **params) -> ChatCopyNodeOutputByCodeHashResponse
client.chat.create_session(**params) -> CreateChatSessionResponse
client.chat.delete_input_file(chat_id, **params) -> ChatDeleteInputFileResponse
client.chat.delete_session(session_id) -> DeleteChatSessionResponse
client.chat.get_dependencies(session_id) -> GetDependenciesResponse
client.chat.get_git_commit(commit_hash, *, chat_id) -> ChatGetGitCommitResponse
client.chat.get_partial_chats(chat_session_id) -> ChatGetPartialChatsResponse
client.chat.get_session(session_id) -> GetChatSessionResponse
client.chat.get_session_timeline(session_id) -> ChatGetSessionTimelineResponse
client.chat.get_template(template_id) -> ChatTemplate
client.chat.grant_admin_override(chat_id, **params) -> AdminGrantAccessResponse
client.chat.list_collaborators(chat_id) -> ListCollaboratorsResponse
client.chat.list_dashboards(chat_id, **params) -> ListDashboardsResponse
client.chat.list_input_files(chat_id) -> ChatListInputFilesResponse
client.chat.list_sessions(**params) -> ListChatSessionsResponse
client.chat.list_templates() -> ChatListTemplatesResponse
client.chat.load_files(**params) -> ChatLoadFilesResponse
client.chat.load_input_file(filename, *, chat_id) -> BinaryAPIResponse
client.chat.load_input_files(chat_id, **params) -> ChatLoadInputFilesResponse
client.chat.make_permanent(session_id) -> None
client.chat.remove_collaborator(user_id, *, chat_id) -> None
client.chat.revert_to_commit(session_id, **params) -> ChatRevertToCommitResponse
client.chat.simulate_prompt(chat_session_id, **params) -> SimulatePromptResponse
client.chat.update_session(session_id, **params) -> ChatSession
client.chat.update_session_favorite(session_id, **params) -> ChatSession
client.chat.update_visibility(session_id, **params) -> UpdateVisibilityResponse
client.chat.upload_input_file(chat_id, **params) -> ChatUploadInputFileResponse

Teams

Types:

from structify.types import (
    AcceptInvitationRequest,
    AcceptInvitationResponse,
    AddMemberRequest,
    AddMemberResponse,
    CreateProjectRequest,
    CreateTeamRequest,
    CreateTeamResponse,
    CreditsUsageRequest,
    CreditsUsageResponse,
    CreditsUsageTimeseriesPoint,
    GetTeamResponse,
    Granularity,
    InvitationDetailsResponse,
    ListMembersResponse,
    ListProjectsResponse,
    ListTeamsResponse,
    RemoveMemberResponse,
    SelectTeamResponse,
    Team,
    TeamRole,
    TeamSubscriptionStatus,
    TeamWithRole,
    UpdateMemberRoleRequest,
    UpdateMemberRoleResponse,
    UpdateTeamRequest,
    UpdateTeamResponse,
    UsageGroupKey,
)

Methods:

client.teams.create(**params) -> CreateTeamResponse
client.teams.update(team_id, **params) -> UpdateTeamResponse
client.teams.list() -> ListTeamsResponse
client.teams.accept_invitation(**params) -> AcceptInvitationResponse
client.teams.add_member(team_id, **params) -> AddMemberResponse
client.teams.cancel_invitation(team_id, **params) -> None
client.teams.create_project(team_id, **params) -> Project
client.teams.credits_usage(team_id, **params) -> CreditsUsageResponse
client.teams.get(team_id) -> GetTeamResponse
client.teams.invitation_details(token) -> InvitationDetailsResponse
client.teams.list_members(team_id) -> ListMembersResponse
client.teams.list_projects(team_id) -> ListProjectsResponse
client.teams.remove_member(user_id, *, team_id) -> RemoveMemberResponse
client.teams.select(team_id) -> SelectTeamResponse
client.teams.update_member_role(user_id, *, team_id, **params) -> UpdateMemberRoleResponse

Wiki

Types:

from structify.types import (
    CreateWikiPageRequest,
    UpdateWikiPageRequest,
    WikiConnectorReference,
    WikiPage,
    WikiPageWithReferences,
    WikiListResponse,
)

Methods:

client.wiki.create(team_id, **params) -> WikiPage
client.wiki.update(slug, *, team_id, **params) -> WikiPage
client.wiki.list(team_id) -> WikiListResponse
client.wiki.delete(slug, *, team_id) -> None
client.wiki.get(slug, *, team_id) -> WikiPageWithReferences

Projects

Types:

from structify.types import (
    DeleteProjectResponse,
    Project,
    ProjectCollaboratorInput,
    ProjectMember,
    ProjectVisibility,
    UpdateProjectRequest,
    ProjectGetResponse,
)

Methods:

client.projects.update(project_id, *, team_id, **params) -> Project
client.projects.delete(project_id, *, team_id) -> DeleteProjectResponse
client.projects.get(project_id, *, team_id) -> ProjectGetResponse

Admin

Types:

from structify.types import ReportCriticalRequest

Methods:

client.admin.report_critical(**params) -> None

Teams

Types:

from structify.types.admin import (
    AdminAddMemberRequest,
    AdminAddMemberResponse,
    AdminListMembersResponse,
    AdminRemoveMemberRequest,
    AdminRemoveMemberResponse,
    AdminTeamsListResponse,
    CancelSubscriptionRequest,
    CancelSubscriptionResponse,
    CreateSubscriptionResponse,
    CreateTeamSubscriptionRequest,
    ExpireGrantsRequest,
    ExpireGrantsResponse,
    ExtendTrialRequest,
    ExtendTrialResponse,
    GrantCreditsRequest,
    GrantCreditsResponse,
    UpdateSeatsOverrideRequest,
    UpdateSeatsOverrideResponse,
    TeamListResponse,
)

Methods:

client.admin.teams.list(**params) -> TeamListResponse
client.admin.teams.add_member(**params) -> AdminAddMemberResponse
client.admin.teams.cancel_subscription(**params) -> CancelSubscriptionResponse
client.admin.teams.create_subscription(**params) -> CreateSubscriptionResponse
client.admin.teams.expire_grants(**params) -> ExpireGrantsResponse
client.admin.teams.extend_trial(**params) -> ExtendTrialResponse
client.admin.teams.grant_credits(**params) -> GrantCreditsResponse
client.admin.teams.list_members(team_id) -> AdminListMembersResponse
client.admin.teams.remove_member(**params) -> AdminRemoveMemberResponse
client.admin.teams.update_seats_override(**params) -> UpdateSeatsOverrideResponse

Dataset

Types:

from structify.types.admin import AdminDatasetReturn

Methods:

client.admin.dataset.get_by_id(**params) -> AdminDatasetReturn

Jobs

Types:

from structify.types.admin import (
    AdminDeleteJobsRequest,
    AdminDeleteJobsResponse,
    AdminListJobsRequestParams,
    JobListResponse,
    JobConcurrencyResponse,
    JobKillByUserResponse,
    JobRunningStatsResponse,
    JobUpdateConcurrencyResponse,
)

Methods:

client.admin.jobs.list(**params) -> SyncJobsList[JobListResponse]
client.admin.jobs.delete(**params) -> AdminDeleteJobsResponse
client.admin.jobs.concurrency() -> JobConcurrencyResponse
client.admin.jobs.kill_by_user(**params) -> JobKillByUserResponse
client.admin.jobs.running_stats() -> JobRunningStatsResponse
client.admin.jobs.update_concurrency(**params) -> JobUpdateConcurrencyResponse

Sandbox

Methods:

client.admin.sandbox.list(**params) -> SyncJobsList[Sandbox]

FunctionalTests

Types:

from structify.types.admin import (
    CreateFunctionalTestRequest,
    FunctionalTest,
    FunctionalTestResultsResponse,
    GetResultsQuery,
    LinkChatToFunctionalTestRequest,
    UpdateFunctionalTestResultsRequest,
    FunctionalTestListResponse,
    FunctionalTestSystemPromptResponse,
)

Methods:

client.admin.functional_tests.create(**params) -> FunctionalTest
client.admin.functional_tests.list() -> FunctionalTestListResponse
client.admin.functional_tests.get_results(**params) -> FunctionalTestResultsResponse
client.admin.functional_tests.link_chat(**params) -> None
client.admin.functional_tests.system_prompt() -> str
client.admin.functional_tests.update_results(**params) -> None

Users

Types:

from structify.types.admin import (
    ImpersonateRequest,
    ImpersonateResponse,
    User,
    UserListResponse,
    UserGetStatsResponse,
)

Methods:

client.admin.users.create(**params) -> TokenResponse
client.admin.users.list() -> UserListResponse
client.admin.users.get_stats(**params) -> UserGetStatsResponse
client.admin.users.impersonate(**params) -> ImpersonateResponse

ChatTemplates

Types:

from structify.types.admin import (
    AdminChatTemplateListQuery,
    CreateChatTemplateRequest,
    UpdateChatTemplateRequest,
    ChatTemplateListResponse,
)

Methods:

client.admin.chat_templates.create(**params) -> ChatTemplate
client.admin.chat_templates.update(template_id, **params) -> ChatTemplate
client.admin.chat_templates.list(**params) -> ChatTemplateListResponse

Connector

Types:

from structify.types.admin import (
    AdminListConnectorsResponse,
    CloneConnectorItem,
    CloneConnectorsRequest,
    DatahubIngestionKey,
    DatahubIngestionType,
    SetDatahubConfigRequest,
    ConnectorCloneResponse,
)

Methods:

client.admin.connector.clone(**params) -> ConnectorCloneResponse
client.admin.connector.list_team_connectors(team_id) -> AdminListConnectorsResponse
client.admin.connector.set_datahub_config(**params) -> Connector

Datasets

Types:

from structify.types import (
    MergeConfig,
    RelationshipMergeStrategy,
    Strategy,
    DatasetCreateResponse,
    DatasetListResponse,
    DatasetCountMissingEmbeddingsResponse,
    DatasetEnrichmentProgressResponse,
    DatasetGetResponse,
    DatasetMatchResponse,
    DatasetViewRelationshipsResponse,
    DatasetViewTableResponse,
    DatasetViewTablesWithRelationshipsResponse,
)

Methods:

client.datasets.create(**params) -> str
client.datasets.list() -> DatasetListResponse
client.datasets.delete(**params) -> None
client.datasets.add_property(**params) -> None
client.datasets.count_missing_embeddings(**params) -> DatasetCountMissingEmbeddingsResponse
client.datasets.enrichment_progress(**params) -> DatasetEnrichmentProgressResponse
client.datasets.export_to_csv(**params) -> None
client.datasets.export_to_excel(**params) -> None
client.datasets.get(**params) -> DatasetGetResponse
client.datasets.match(**params) -> DatasetMatchResponse
client.datasets.remove_property(**params) -> None
client.datasets.reorder_properties(**params) -> None
client.datasets.set_primary_column(**params) -> None
client.datasets.update_property(**params) -> None
client.datasets.update_relationship(**params) -> None
client.datasets.view_relationships(**params) -> SyncJobsList[DatasetViewRelationshipsResponse]
client.datasets.view_table(**params) -> SyncJobsList[DatasetViewTableResponse]
client.datasets.view_tables_with_relationships(**params) -> DatasetViewTablesWithRelationshipsResponse

Documents

Types:

from structify.types import DocumentListResponse, DocumentDownloadResponse

Methods:

client.documents.list(**params) -> DocumentListResponse
client.documents.delete(**params) -> None
client.documents.download(**params) -> DocumentDownloadResponse
client.documents.upload(**params) -> None

Jobs

Types:

from structify.types import (
    GetJobEventsResponse,
    JobListResponse,
    JobCancelResponse,
    JobGetResponse,
    JobStatusResponse,
)

Methods:

client.jobs.list(**params) -> SyncJobsList[JobListResponse]
client.jobs.cancel(uuid) -> JobCancelResponse
client.jobs.get(job_id) -> JobGetResponse
client.jobs.get_events(job_id) -> GetJobEventsResponse
client.jobs.schedule() -> None
client.jobs.status(**params) -> JobStatusResponse

Match

Types:

from structify.types import (
    CreateMatchJobsRequest,
    CreateMatchJobsResponse,
    ListMatchResultsParams,
    MatchResult,
)

Methods:

client.match.create_jobs(**params) -> CreateMatchJobsResponse
client.match.list_results(**params) -> SyncJobsList[MatchResult]

Sessions

Types:

from structify.types import (
    AutofixContext,
    CellEdit,
    ConfirmNodeRequest,
    CreateWorkflowSessionRequest,
    Dashboard,
    DashboardComponent,
    DashboardPage,
    DashboardSpec,
    EdgeSpec,
    EditNodeOutputRequest,
    FinalizeDagRequest,
    FinalizeDagResponse,
    GetNodeLogsResponse,
    GetNodeResponse,
    JobEventBody,
    MarkWorkflowSessionErroredRequest,
    NodeSpec,
    ParquetEdit,
    RequestConfirmationRequest,
    TriggerReviewResponse,
    UpdateWorkflowNodeProgressRequest,
    UpdateWorkflowNodeRequest,
    UploadDashboardLayoutRequest,
    UploadNodeVisualizationOutputRequest,
    VizBooleanControl,
    VizBooleanControlType,
    VizControlOption,
    VizDateControl,
    VizDateControlType,
    VizFigure,
    VizFigureDefinition,
    VizFigureKind,
    VizNumberControl,
    VizNumberControlType,
    VizParam,
    VizQuery,
    VizStringControl,
    VizStringControlType,
    WorkflowDag,
    WorkflowDashboardItem,
    WorkflowNodeExecutionStatus,
    WorkflowNodeLog,
    WorkflowSession,
    WorkflowSessionEdge,
    WorkflowSessionNode,
    SessionEditNodeOutputResponse,
    SessionGetEventsResponse,
    SessionGetNodeProgressResponse,
    SessionKillJobsResponse,
)

Methods:

client.sessions.confirm_node(node_id, **params) -> WorkflowSessionNode
client.sessions.create_session(**params) -> WorkflowSession
client.sessions.edit_node_output(node_id, **params) -> SessionEditNodeOutputResponse
client.sessions.finalize_dag(session_id, **params) -> FinalizeDagResponse
client.sessions.get_dag(session_id) -> WorkflowDag
client.sessions.get_events(node_id, **params) -> SessionGetEventsResponse
client.sessions.get_node(node_id) -> GetNodeResponse
client.sessions.get_node_logs(node_id) -> GetNodeLogsResponse
client.sessions.get_node_output_data(node_id) -> BinaryAPIResponse
client.sessions.get_node_progress(node_id) -> SessionGetNodeProgressResponse
client.sessions.kill_jobs(session_id, **params) -> SessionKillJobsResponse
client.sessions.mark_errored(session_id, **params) -> WorkflowSession
client.sessions.request_confirmation(node_id, **params) -> WorkflowSessionNode
client.sessions.trigger_review(session_id) -> TriggerReviewResponse
client.sessions.update_node(node_id, **params) -> WorkflowSessionNode
client.sessions.update_node_progress(node_id, **params) -> WorkflowSessionNode
client.sessions.upload_dashboard_layout(session_id, **params) -> WorkflowSession
client.sessions.upload_node_output_data(node_id, **params) -> WorkflowSessionNode
client.sessions.upload_node_visualization_output(node_id, **params) -> WorkflowSessionNode

WorkflowSchedule

Types:

from structify.types import (
    CreateWorkflowScheduleRequest,
    GetWorkflowScheduleSessionsRequest,
    GetWorkflowScheduleSessionsResponse,
    UpdateWorkflowScheduleRequest,
    WorkflowScheduleInfo,
    WorkflowScheduleGetAllResponse,
)

Methods:

client.workflow_schedule.create(chat_session_id, **params) -> WorkflowScheduleInfo
client.workflow_schedule.update(schedule_id, **params) -> WorkflowScheduleInfo
client.workflow_schedule.delete(schedule_id) -> None
client.workflow_schedule.get(chat_session_id) -> Optional[WorkflowScheduleInfo]
client.workflow_schedule.get_all() -> WorkflowScheduleGetAllResponse
client.workflow_schedule.get_sessions(schedule_id, **params) -> GetWorkflowScheduleSessionsResponse
client.workflow_schedule.pause(schedule_id, **params) -> WorkflowScheduleInfo
client.workflow_schedule.run(schedule_id) -> None

Workflow

Types:

from structify.types import RunWorkflowRequest, StopWorkflowRequest

Methods:

client.workflow.run(**params) -> None
client.workflow.stop(**params) -> None

Connectors

Types:

from structify.types import (
    Connector,
    ConnectorCategory,
    ConnectorExplorerChat,
    ConnectorStoreResponse,
    ConnectorSummariesRequest,
    ConnectorSummary,
    ConnectorTableInfo,
    ConnectorTablePathResponse,
    ConnectorWithSecrets,
    ConnectorWithSnippets,
    CreateConnectorRequest,
    CreateSecretRequest,
    DatahubProgress,
    DatahubSecretMap,
    DeleteSchemaObjectRequest,
    DeleteSchemaObjectResponse,
    ExplorationPhaseID,
    ExplorationProgress,
    ExplorationRun,
    ExplorationRunsResponse,
    ExplorationStatus,
    ExploreConnectorRequest,
    ExplorerChatResponse,
    ListTablesResponse,
    LlmInformationStore,
    PhaseActivity,
    SchemaObjectID,
    UpdateColumnRequest,
    UpdateConnectorRequest,
    UpdateTableRequest,
    UpdateTableResponse,
    ConnectorAddSchemaObjectResponse,
    ConnectorExploreResponse,
    ConnectorGetResponse,
    ConnectorGetClarificationRequestsResponse,
    ConnectorListStoresResponse,
    ConnectorListWithSnippetsResponse,
    ConnectorSearchTablesResponse,
    ConnectorSummariesResponse,
)

Methods:

client.connectors.create(**params) -> Connector
client.connectors.update(connector_id, **params) -> None
client.connectors.list(**params) -> SyncJobsList[ConnectorWithSecrets]
client.connectors.delete(connector_id) -> None
client.connectors.add_schema_object(connector_id, **params) -> ConnectorAddSchemaObjectResponse
client.connectors.create_secret(connector_id, **params) -> None
client.connectors.delete_schema_object(connector_id, **params) -> DeleteSchemaObjectResponse
client.connectors.delete_secret(secret_name, *, connector_id) -> None
client.connectors.download_datahub_artifact(kind, *, connector_id, **params) -> BinaryAPIResponse
client.connectors.explore(connector_id, **params) -> ConnectorExploreResponse
client.connectors.get(connector_id) -> ConnectorGetResponse
client.connectors.get_active_exploration_run(connector_id) -> Optional[ExplorationRun]
client.connectors.get_clarification_requests(connector_id) -> ConnectorGetClarificationRequestsResponse
client.connectors.get_exploration_run_progress(run_id, *, connector_id) -> ExplorationProgress
client.connectors.get_exploration_runs(connector_id) -> ExplorationRunsResponse
client.connectors.get_explorer_chat(connector_id, **params) -> ExplorerChatResponse
client.connectors.get_store(connector_id) -> ConnectorStoreResponse
client.connectors.get_table_path(table_id) -> ConnectorTablePathResponse
client.connectors.list_stores() -> ConnectorListStoresResponse
client.connectors.list_tables(connector_id) -> ListTablesResponse
client.connectors.list_with_snippets() -> ConnectorListWithSnippetsResponse
client.connectors.resolve_clarification(clarification_id) -> None
client.connectors.search_tables(**params) -> ConnectorSearchTablesResponse
client.connectors.summaries(**params) -> ConnectorSummariesResponse
client.connectors.update_column(column_id, **params) -> None
client.connectors.update_table(table_id, **params) -> UpdateTableResponse
client.connectors.upload_datahub_artifact(kind, *, connector_id, **params) -> None

TypeSnippets

Types:

from structify.types.connectors import Snippet, UpsertRequest

Methods:

client.connectors.type_snippets.upsert(connector_type, **params) -> Snippet

ConnectorCatalog

Types:

from structify.types import (
    ConnectorAuthMethod,
    ConnectorAuthMethodWithFields,
    ConnectorCatalog,
    ConnectorCatalogWithMethods,
    ConnectorCredentialField,
    ConnectorCatalogListResponse,
)

Methods:

client.connector_catalog.list(**params) -> ConnectorCatalogListResponse
client.connector_catalog.get(slug) -> ConnectorCatalogWithMethods
client.connector_catalog.get_logo(slug) -> BinaryAPIResponse

Admin

Types:

from structify.types.connector_catalog import (
    BatchCreateCredentialFieldsRequest,
    BatchCreateScopesRequest,
    BatchCreateScopesResponse,
    ConnectorAuthMethodScope,
    CreateAuthMethodRequest,
    CreateCatalogRequest,
    CreateCredentialFieldRequest,
    CreateScopeRequest,
    ListScopesResponse,
    PendingNangoIntegration,
    UpdateAuthMethodRequest,
    UpdateCatalogRequest,
    UpdateCredentialFieldRequest,
    UpdateScopeRequest,
    UploadLogoResponse,
    AdminBatchCreateCredentialFieldsResponse,
    AdminListNangoPendingResponse,
)

Methods:

client.connector_catalog.admin.batch_create_credential_fields(**params) -> AdminBatchCreateCredentialFieldsResponse
client.connector_catalog.admin.batch_create_scopes(**params) -> BatchCreateScopesResponse
client.connector_catalog.admin.create_auth_method(**params) -> ConnectorAuthMethod
client.connector_catalog.admin.create_catalog(**params) -> ConnectorCatalog
client.connector_catalog.admin.create_credential_field(**params) -> ConnectorCredentialField
client.connector_catalog.admin.create_scope(**params) -> ConnectorAuthMethodScope
client.connector_catalog.admin.delete_catalog(id) -> None
client.connector_catalog.admin.delete_credential_field(id) -> None
client.connector_catalog.admin.delete_scope(id) -> None
client.connector_catalog.admin.list_nango_pending() -> AdminListNangoPendingResponse
client.connector_catalog.admin.list_scopes(**params) -> ListScopesResponse
client.connector_catalog.admin.update_auth_method(id, **params) -> ConnectorAuthMethod
client.connector_catalog.admin.update_catalog(id, **params) -> ConnectorCatalog
client.connector_catalog.admin.update_credential_field(id, **params) -> ConnectorCredentialField
client.connector_catalog.admin.update_scope(id, **params) -> ConnectorAuthMethodScope
client.connector_catalog.admin.upload_logo(slug, **params) -> UploadLogoResponse

Server

Types:

from structify.types import ServerInformation

Methods:

client.server.version() -> ServerInformation

Sources

Types:

from structify.types import (
    DeleteSourceEntityParams,
    DeleteSourceEntityResponse,
    DeleteSourceRelationshipParams,
    DeleteSourceRelationshipResponse,
    Source,
    SourceListResponse,
)

Methods:

client.sources.list(**params) -> SourceListResponse
client.sources.delete_entity(**params) -> DeleteSourceEntityResponse
client.sources.delete_relationship(**params) -> DeleteSourceRelationshipResponse

Entities

Types:

from structify.types import (
    EntityDeleteResponse,
    EntityAddResponse,
    EntityAddBatchResponse,
    EntityAddRelationshipResponse,
    EntityDeriveResponse,
    EntityDeriveAllResponse,
    EntityGetResponse,
    EntityGetLocalSubgraphResponse,
    EntityGetSourceEntitiesResponse,
    EntityListJobsResponse,
    EntitySearchResponse,
    EntitySummarizeResponse,
    EntityUpdatePropertyResponse,
    EntityViewResponse,
)

Methods:

client.entities.delete(**params) -> EntityDeleteResponse
client.entities.add(**params) -> EntityAddResponse
client.entities.add_batch(**params) -> EntityAddBatchResponse
client.entities.add_relationship(**params) -> EntityAddRelationshipResponse
client.entities.delete_relationship(**params) -> object
client.entities.derive(**params) -> str
client.entities.derive_all(**params) -> EntityDeriveAllResponse
client.entities.get(**params) -> EntityGetResponse
client.entities.get_local_subgraph(**params) -> EntityGetLocalSubgraphResponse
client.entities.get_source_entities(**params) -> EntityGetSourceEntitiesResponse
client.entities.list_jobs(**params) -> EntityListJobsResponse
client.entities.search(**params) -> EntitySearchResponse
client.entities.summarize(**params) -> EntitySummarizeResponse
client.entities.update_property(**params) -> EntityUpdatePropertyResponse
client.entities.upload_parquet(**params) -> None
client.entities.verify(**params) -> KnowledgeGraph
client.entities.view(**params) -> EntityViewResponse

Sandbox

Types:

from structify.types import (
    GetSandboxRequest,
    Sandbox,
    SandboxListResponse,
    SandboxGetMetricsResponse,
)

Methods:

client.sandbox.list(chat_id) -> SandboxListResponse
client.sandbox.get(chat_id, **params) -> Sandbox
client.sandbox.get_metrics(sandbox_id) -> SandboxGetMetricsResponse
client.sandbox.update_status(sandbox_id, **params) -> Sandbox

Scrape

Types:

from structify.types import (
    ScrapeListRequest,
    ScrapeRequest,
    ScrapeListResponse,
    ScrapeScrapeResponse,
)

Methods:

client.scrape.list(**params) -> ScrapeListResponse
client.scrape.scrape(**params) -> ScrapeScrapeResponse

Code

Types:

from structify.types import ApplyManualEditRequest, GenerateCodeRequest, InterruptGenerationRequest

Methods:

client.code.apply_manual_edit(chat_id, **params) -> None
client.code.generate_code(**params) -> None
client.code.interrupt_generation(**params) -> None

Structure

Types:

from structify.types import (
    ChatPrompt,
    SaveRequirement,
    StructureEnhancePropertyResponse,
    StructureEnhanceRelationshipResponse,
    StructureFindRelationshipResponse,
    StructureIsCompleteResponse,
    StructureJobStatusResponse,
    StructurePdfResponse,
    StructureRunAsyncResponse,
)

Methods:

client.structure.enhance_property(**params) -> str
client.structure.enhance_relationship(**params) -> str
client.structure.find_relationship(**params) -> str
client.structure.is_complete(**params) -> str
client.structure.job_status(**params) -> StructureJobStatusResponse
client.structure.pdf(**params) -> StructurePdfResponse
client.structure.run_async(**params) -> str

PublicSessions

Methods:

client.public_sessions.get_latest_workflow(chat_session_id) -> WorkflowDag
client.public_sessions.get_node_output_data(node_id) -> BinaryAPIResponse

Shared

Types:

from structify.types import (
    DatasetDescriptor,
    Entity,
    EntityMatch,
    Image,
    KnowledgeGraph,
    PropertyType,
    Relationship,
    Table,
)

Slack

Types:

from structify.types import SlackAPIResponse, SlackEventPayload

Methods:

client.slack.events(**params) -> SlackAPIResponse

Nango

Types:

from structify.types import (
    ConnectSession,
    CreateNangoSessionRequest,
    Integration,
    NangoCreateSessionResponse,
    NangoListIntegrationsResponse,
)

Methods:

client.nango.create_session(**params) -> NangoCreateSessionResponse
client.nango.list_integrations() -> NangoListIntegrationsResponse

FilesExpand file tree

api.md

Latest commit

History

api.md

File metadata and controls

Whitelabel

User

Stripe

APIKeys

Chat

Teams

Wiki

Projects

Admin

Teams

Dataset

Jobs

Sandbox

FunctionalTests

Users

ChatTemplates

Connector

Datasets

Documents

Jobs

Match

Sessions

WorkflowSchedule

Workflow

Connectors

TypeSnippets

ConnectorCatalog

Admin

Server

Sources

Entities

Sandbox

Scrape

Code

Structure

PublicSessions

Shared

Slack

Nango