# Instabase AI Hub Docs

> Instabase AI Hub brings you the power of large language models (LLMs) so that you can get information from any kind of document.

{/*<!-- vale Microsoft.Headings = NO -->*/}

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" />

<div>
  <h1>
    Instabase AI Hub Documentation
  </h1>

  <h3>
    Quickly understand and extract information from complex documents
  </h3>

  <div>
    <div>
      <div>
        <i />
      </div>

      <h3>
        Get started
      </h3>

      <p>
        Learn what AI Hub can do and how it works, and try out sample tasks to get a feel for what's possible.
      </p>

      <a href="/overview/getting-started">
        Learn more
      </a>
    </div>

    <div>
      <div>
        <i />
      </div>

      <h3>
        Automate workflows
      </h3>

      <p>
        Use prebuilt or custom apps for document processing. Run apps on-demand or scale operations with automation, integration, and human review.
      </p>

      <a href="/automate/overview">
        Learn more
      </a>
    </div>

    <div>
      <div>
        <i />
      </div>

      <h3>
        Analyze documents
      </h3>

      <p>
        Use chatbots and conversations to interact with and analyze your documents. Summarize content, extract information, and compare data.
      </p>

      <a href="/analyze">
        Learn more
      </a>
    </div>

    <div>
      <div>
        <i />
      </div>

      <h3>
        Integrate with API & SDK
      </h3>

      <p>
        Build integrations using the APIs and SDK. Automate document processing, interact with chatbots, and incorporate AI Hub capabilities into your applications.
      </p>

      <a href="/api-sdk">
        Learn more
      </a>
    </div>

    <div>
      <div>
        <i />
      </div>

      <h3>
        Track updates
      </h3>

      <p>
        Check out the latest AI Hub features, improvements, and fixes in the release notes.
      </p>

      <a href="/release-notes">
        Learn more
      </a>
    </div>

    <div>
      <div>
        <i />
      </div>

      <h3>
        Chat with the docsbot
      </h3>

      <p>
        Chat with the documentation chatbot to get the answers you need. This AI Hub chatbot is free to use.
      </p>

      <a href="https://aihub.instabase.com/hub/apps/shared/Instabase/Explore%20AIHub%20Docs">
        Learn more
      </a>
    </div>
  </div>

  <div>
    <p>
      AI Hub is supported on the most recent two versions of Chrome, Edge, Firefox, Opera, and Safari.
    </p>
  </div>
</div>


## Docs

- [Getting started](https://docs.instabase.com/overview/getting-started.mdx): Overview of AI Hub capabilities, architecture, and core components.
- [Account setup](https://docs.instabase.com/overview/account-setup.mdx): Get started with AI Hub by creating or joining an organization.
- [Release notes](https://docs.instabase.com/release-notes.mdx): Important release updates for Instabase AI Hub.
- [AI runtime release notes](https://docs.instabase.com/ai-runtime.mdx): Important release updates for AI runtime.
- [Release timeline](https://docs.instabase.com/versions.mdx): AI Hub and AI runtime release dates.
- [Glossary](https://docs.instabase.com/overview/glossary.mdx): Reference of terms used in AI Hub.
- [Choosing a model](https://docs.instabase.com/overview/models.mdx): Choose the model that best suits your needs, balancing speed, accuracy, and cost.
- [File limitations and processing](https://docs.instabase.com/overview/limitations.mdx): Be aware of the technical limitations and supported files types for AI Hub.
- [Supported languages](https://docs.instabase.com/overview/languages.mdx): Language support varies depending on your digitization settings and documents.
- [List of visual tutorials](https://docs.instabase.com/overview/visual-tutorials.mdx): List of visual tutorials that are embedded in individual documentation pages.
- [Upgrades and maintenance](https://docs.instabase.com/policies/upgrades.mdx): Learn about upgrades and maintenance for your AI Hub environment.
- [Data privacy and security](https://docs.instabase.com/policies/privacy-policy.mdx): Instabase AI Hub was designed with security, confidentiality, and compliance in mind.
- [LLM best practices](https://docs.instabase.com/policies/best-practices.mdx): When you use AI Hub, be aware of the limitations of LLMs, and follow best practices.
- [About automation apps](https://docs.instabase.com/automate/overview.mdx): Automation capabilities transform documents into structured, actionable data.
- [Creating apps](https://docs.instabase.com/automate/creating.mdx): Transform your document processing requirements into reusable, shareable solutions.
- [Working with automation projects](https://docs.instabase.com/automate/projects.mdx): Understanding the automation project interface can help you efficiently create automation apps.
- [Extracting data from documents](https://docs.instabase.com/automate/document-schema.mdx): Specify classes and fields that define your project schema.
- [Cleaning results](https://docs.instabase.com/automate/cleaning.mdx): Refine extracted data using a variety of cleaning options.
- [Validating documents](https://docs.instabase.com/automate/validating-documents.mdx): Ensure high-quality output by implementing validation rules.
- [Creating or versioning apps](https://docs.instabase.com/automate/app-versions.mdx): Package your project into a reusable app version so it can be used and deployed.
- [Testing apps](https://docs.instabase.com/automate/testing.mdx): Accuracy testing ensures automation apps meet your accuracy requirements before deployment.
- [Managing ground truth datasets](https://docs.instabase.com/automate/datasets.mdx): Configure ground truth datasets with validated data to use in accuracy testing.
- [Running accuracy tests](https://docs.instabase.com/automate/accuracy.mdx): See how accurate an app is by comparing verified values to actual run results.
- [Running and deploying apps](https://docs.instabase.com/automate/running.mdx): Run apps on-demand, or automate them with deployments.
- [Running apps](https://docs.instabase.com/automate/app-use.mdx): After creating an app, you can run it on-demand, share it, and manage access across your organization.
- [Deploying apps](https://docs.instabase.com/automate/deployments.mdx): Deploy apps to transform them into production-scale, automated workflows.
- [Monitoring deployments](https://docs.instabase.com/automate/monitoring-deployments.mdx): Deployment metrics give you insight into deployment and human review efficiency.
- [Version control for apps](https://docs.instabase.com/automate/version-control.mdx): Manage versioning for apps and AI runtime.
- [Reviewing results](https://docs.instabase.com/automate/review.mdx): Human review enables validating and correcting results from deployment runs.
- [Writing custom functions](https://docs.instabase.com/automate/custom-functions.mdx): Follow these guidelines when writing custom functions to use in automation projects and deployments.
- [About chatbots and conversations](https://docs.instabase.com/analyze.mdx): AI Hub supports advanced document analysis using chatbots and conversations.
- [Creating conversations](https://docs.instabase.com/chat/converse.mdx): Query your documents in a conversation.
- [Creating chatbots](https://docs.instabase.com/chat/creating-chatbots.mdx): Create a chatbot from any conversation.
- [Using chatbots](https://docs.instabase.com/chat/using-chatbots.mdx): Query a knowledge base of documents using chatbots.
- [Effectively analyzing documents](https://docs.instabase.com/chat/analyzing-documents.mdx): Explore supported functionality available in conversations and chatbots.
- [About administration tools](https://docs.instabase.com/admin.mdx): Configure and manage AI Hub settings, user access, and integrations.
- [Account settings](https://docs.instabase.com/admin/account-settings.mdx): Manage your account information and security settings.
- [User and access management](https://docs.instabase.com/admin/user-mgmt.mdx): Manage user and team access in AI Hub.
- [Managing organization members](https://docs.instabase.com/admin/org-members.mdx): Add and manage your organization's members.
- [Managing workspace members](https://docs.instabase.com/admin/workspace-members.mdx): Add and manage members of shared workspaces.
- [Organization and workspace roles](https://docs.instabase.com/admin/roles.mdx): Use organization and workspace roles to manage member permissions.
- [Managing workspaces](https://docs.instabase.com/admin/workspace-management.mdx): Manage shared workspaces, including designating production workspaces.
- [Managing groups](https://docs.instabase.com/admin/group-management.mdx): Create groups to manage workspace access and permissions.
- [Managing service accounts](https://docs.instabase.com/admin/service-accounts.mdx): Manage service accounts and their API tokens.
- [Enabling preview features](https://docs.instabase.com/admin/preview-features.mdx): Try out features available in public preview.
- [Authentication and security](https://docs.instabase.com/admin/security.mdx): Secure your environment and control user access with AI Hub's authentication and security features.
- [Configuring SAML SSO for multi-tenant AI Hub](https://docs.instabase.com/admin/saml-sso.mdx): Configure SAML-based single sign-on for multi-tenant AI Hub.
- [Configuring SAML SSO for single-tenant AI Hub](https://docs.instabase.com/admin/saml-sso-st.mdx): Configure SAML-based single sign-on for single-tenant AI Hub.
- [Configuring OIDC SSO for multi-tenant AI Hub](https://docs.instabase.com/admin/oidc-sso.mdx): Configure OIDC-based single sign-on for multi-tenant AI Hub.
- [Configuring OIDC SSO for single-tenant AI Hub](https://docs.instabase.com/admin/oidc-sso-st.mdx): Configure OIDC-based single sign-on for single-tenant AI Hub.
- [Managing secrets](https://docs.instabase.com/admin/secret-management.mdx): Use secrets to securely store and reference sensitive information.
- [Viewing audit logs](https://docs.instabase.com/admin/audit-logs.mdx): View audit logs for your single-tenant environment.
- [About data connections](https://docs.instabase.com/admin/data-connections.mdx): Connect external data sources as input sources, output destinations, or storage locations.
- [Managing default drives](https://docs.instabase.com/admin/data-sources/default-drives.mdx): Configure the default storage for AI Hub files.
- [Connecting Amazon S3](https://docs.instabase.com/admin/data-sources/amazon-s3-connect.mdx): Add Amazon S3 as a data connection.
- [Connecting Azure Blob Storage](https://docs.instabase.com/admin/data-sources/azure-blob-storage-connect.mdx): Add Azure Blob Storage as a data connection.
- [Connecting Google Cloud Storage](https://docs.instabase.com/admin/data-sources/google-cloud-storage-connect.mdx): Add Google Cloud Storage as a data connection.
- [Connecting Google Drive](https://docs.instabase.com/admin/data-sources/google-drive-connect.mdx): Add Google Drive as a data connection.
- [Connecting mailboxes](https://docs.instabase.com/admin/data-sources/connect-mail.mdx): Connect mailboxes for use as an upstream integration.
- [Managing subscriptions](https://docs.instabase.com/admin/subscriptions.mdx): Manage your AI Hub subscription.
- [Managing billing and invoices](https://docs.instabase.com/admin/billing.mdx): Manage your account or organization's billing details and invoices.
- [Monitoring usage](https://docs.instabase.com/admin/usage.mdx): Monitor your account or organization's usage.
- [Network architecture requirements](https://docs.instabase.com/admin/network-architecture.mdx): For self-managed AI Hub deployments in a VPC environment, AI Hub requires specific outbound network connectivity.
- [Using the API and SDK](https://docs.instabase.com/api-sdk/using-api-sdk.mdx): Get started using the AI Hub API and SDK.
- [Authorization and context identification](https://docs.instabase.com/api-sdk/authorization.mdx): Manage AI Hub API tokens and understand request context.
- [Response statuses](https://docs.instabase.com/api-sdk/api-reference/response-statuses.mdx): Review AI Hub API response classes.
- [Introduction to the SDK](https://docs.instabase.com/api-sdk/sdk-for-beginners/1-intro.mdx): Tutorial -- Learn to use the AI Hub SDK from the ground up, working through real examples.
- [Preparing to use the SDK](https://docs.instabase.com/api-sdk/sdk-for-beginners/2-prepare.mdx): Tutorial -- Installing and authorizing the SDK.
- [Test SDK installation and authorization](https://docs.instabase.com/api-sdk/sdk-for-beginners/3-test.mdx): Tutorial -- Testing the SDK.
- [Automate use case](https://docs.instabase.com/api-sdk/sdk-for-beginners/4-automate.mdx): Tutorial -- Performing automated document processing.
- [Analyze use case](https://docs.instabase.com/api-sdk/sdk-for-beginners/5-analyze.mdx): Tutorial -- Analyzing documents with conversations.
- [Cleanup](https://docs.instabase.com/api-sdk/sdk-for-beginners/6-clean-up.mdx): Cleaning up unneeded files and data.
- [Next steps](https://docs.instabase.com/api-sdk/sdk-for-beginners/7-next.mdx): Tutorial -- Learning more about the SDK.
- [Run automation apps by SDK](https://docs.instabase.com/api-sdk/apps-sdk.mdx): Process files by running automation apps using the AI Hub SDK.
- [Interact with chatbots by API](https://docs.instabase.com/api-sdk/chatbot-api.mdx): Integrate queries to chatbots into your workflow using the AI Hub API.
- [Interact with chatbots by SDK](https://docs.instabase.com/api-sdk/chatbot-sdk.mdx): Integrate queries to chatbots into your workflow using the AI Hub SDK.
- [Interact with conversations by SDK](https://docs.instabase.com/api-sdk/converse-sdk.mdx): Integrate queries to conversations within your own workflow using the AI Hub API.
- [Specifying file paths](https://docs.instabase.com/api-sdk/api-reference/run-reference.mdx): Define file paths in your app and deployment runs.
- [Job status endpoint (Deprecated)](https://docs.instabase.com/api-sdk/api-reference/legacy/job-status-endpoint.mdx): Job status endpoint for getting app run status and results.
- [Run apps endpoint (Deprecated)](https://docs.instabase.com/api-sdk/api-reference/legacy/run-app-endpoint.mdx): API reference for running apps.
- [Run results endpoint (Deprecated)](https://docs.instabase.com/api-sdk/api-reference/legacy/run-results-endpoint.mdx): Flow binary endpoint for getting app run results.
- [Mount endpoint [Deprecated]](https://docs.instabase.com/api-sdk/api-reference/legacy/mount-endpoint.mdx): Connect and manage external drives at the workspace level.

## API Docs

- API reference > Batches [Create batch](https://docs.instabase.com/api-sdk/api-reference/batches/create-batch.mdx)
- API reference > Batches [List batches](https://docs.instabase.com/api-sdk/api-reference/batches/list-batches.mdx)
- API reference > Batches [Get batch information](https://docs.instabase.com/api-sdk/api-reference/batches/get-batch.mdx)
- API reference > Batches [Delete batch](https://docs.instabase.com/api-sdk/api-reference/batches/delete-batch.mdx)
- API reference > Batches [Upload file to batch](https://docs.instabase.com/api-sdk/api-reference/batches/add-file-to-batch.mdx)
- API reference > Batches [List files in a batch](https://docs.instabase.com/api-sdk/api-reference/batches/list-files.mdx)
- API reference > Batches [Delete file from batch](https://docs.instabase.com/api-sdk/api-reference/batches/delete-file-from-batch.mdx)
- API reference > Batches [Poll batches job](https://docs.instabase.com/api-sdk/api-reference/batches/poll-batches-job.mdx)
- API reference > Batches [Start multipart upload session](https://docs.instabase.com/api-sdk/api-reference/batches/create-multipart-upload-session.mdx)
- API reference > Batches [Upload part to multipart session](https://docs.instabase.com/api-sdk/api-reference/batches/upload-multipart-part.mdx)
- API reference > Batches [Commit or abort multipart session](https://docs.instabase.com/api-sdk/api-reference/batches/commit-multipart-upload-session.mdx)
- API reference > Runs [Run deployment](https://docs.instabase.com/api-sdk/api-reference/runs/run-deployment.mdx)
- API reference > Runs [Run app](https://docs.instabase.com/api-sdk/api-reference/runs/run-app.mdx)
- API reference > Runs [Get run status](https://docs.instabase.com/api-sdk/api-reference/runs/get-run-status.mdx)
- API reference > Runs [Get run results](https://docs.instabase.com/api-sdk/api-reference/runs/get-run-results.mdx)
- API reference > Runs [List runs](https://docs.instabase.com/api-sdk/api-reference/runs/list-runs.mdx)
- API reference > Runs [Delete run](https://docs.instabase.com/api-sdk/api-reference/runs/delete-run.mdx)
- API reference > Conversations [Create conversation and upload files](https://docs.instabase.com/api-sdk/api-reference/conversations/create-conversation.mdx)
- API reference > Conversations [List conversations](https://docs.instabase.com/api-sdk/api-reference/conversations/list-conversations.mdx)
- API reference > Conversations [Get conversation information](https://docs.instabase.com/api-sdk/api-reference/conversations/get-conversation.mdx)
- API reference > Conversations [Update conversation information](https://docs.instabase.com/api-sdk/api-reference/conversations/update-conversation.mdx)
- API reference > Conversations [Converse with a document](https://docs.instabase.com/api-sdk/api-reference/conversations/converse.mdx)
- API reference > Conversations [Add documents to a conversation](https://docs.instabase.com/api-sdk/api-reference/conversations/add-documents-to-conversation.mdx)
- API reference > Conversations [Delete documents](https://docs.instabase.com/api-sdk/api-reference/conversations/delete-documents-from-conversation.mdx)
- API reference > Conversations [Get document metadata](https://docs.instabase.com/api-sdk/api-reference/conversations/get-conversation-document-metadata.mdx)
- API reference > Conversations [Delete conversation](https://docs.instabase.com/api-sdk/api-reference/conversations/delete-conversation.mdx)
- API reference > Queries [Run query](https://docs.instabase.com/api-sdk/api-reference/queries/run-query.mdx)
- API reference > Queries [Get query status](https://docs.instabase.com/api-sdk/api-reference/queries/get-query-status.mdx)
- API reference > Jobs [Poll file operation job status](https://docs.instabase.com/api-sdk/api-reference/jobs/job-status.mdx)
- API reference > Secrets [Create secret](https://docs.instabase.com/api-sdk/api-reference/secrets/create-secret.mdx)
- API reference > Secrets [List secrets](https://docs.instabase.com/api-sdk/api-reference/secrets/list-secrets.mdx)
- API reference > Secrets [Update secret](https://docs.instabase.com/api-sdk/api-reference/secrets/update-secret.mdx)
- API reference > Secrets [Delete secret](https://docs.instabase.com/api-sdk/api-reference/secrets/delete-secret.mdx)
- API reference > Files [Read file](https://docs.instabase.com/api-sdk/api-reference/files/read-file.mdx)
- API reference > Files [Create or overwrite file](https://docs.instabase.com/api-sdk/api-reference/files/write-file.mdx)
- API reference > Files [Read file or folder metadata](https://docs.instabase.com/api-sdk/api-reference/files/get-file-metadata.mdx)
- API reference > Files [Delete file or folder](https://docs.instabase.com/api-sdk/api-reference/files/delete-file-or-folder.mdx)
- API reference > Audit [Get audit logs](https://docs.instabase.com/api-sdk/api-reference/audit/get-audit-logs.mdx)