# TrueState Documentation ## Docs - [.............. Same as '/status'.](https://docs.truestate.io/api-reference/-same-as-status.md): Returns `{"status":"ok"}` if backend is alive, same as the "/status" endpoint. Unlike most other endpoints, this one does not require authentication. - [Submit To Assistant](https://docs.truestate.io/api-reference/agents/submit-to-assistant.md) - [Add a new API key for this member](https://docs.truestate.io/api-reference/api-keys/add-a-new-api-key-for-this-member.md): Create a new API key for this user and organisation in the **api_keys** table. - [Delete member's API key](https://docs.truestate.io/api-reference/api-keys/delete-members-api-key.md) - [Get all API keys for the member](https://docs.truestate.io/api-reference/api-keys/get-all-api-keys-for-the-member.md) - [Update member's API key](https://docs.truestate.io/api-reference/api-keys/update-members-api-key.md) - [Create Assistant](https://docs.truestate.io/api-reference/assistants/create-assistant.md) - [Delete Assistant](https://docs.truestate.io/api-reference/assistants/delete-assistant.md) - [Get Assistant](https://docs.truestate.io/api-reference/assistants/get-assistant.md) - [Get Assistants](https://docs.truestate.io/api-reference/assistants/get-assistants.md) - [List Assistants](https://docs.truestate.io/api-reference/assistants/list-assistants.md): This endpoint is used to list all assistants that are available to the user. It includes both default assistants and custom assistants that the user has created. - [Update Assistant](https://docs.truestate.io/api-reference/assistants/update-assistant.md) - [Cancel Session](https://docs.truestate.io/api-reference/automation-sessions/cancel-session.md) - [Create Session](https://docs.truestate.io/api-reference/automation-sessions/create-session.md) - [Get Session](https://docs.truestate.io/api-reference/automation-sessions/get-session.md) - [Create Automation](https://docs.truestate.io/api-reference/automations/create-automation.md) - [Delete Automation](https://docs.truestate.io/api-reference/automations/delete-automation.md) - [Duplicate Automation](https://docs.truestate.io/api-reference/automations/duplicate-automation.md) - [Get Automation](https://docs.truestate.io/api-reference/automations/get-automation.md) - [Get Automations](https://docs.truestate.io/api-reference/automations/get-automations.md) - [Update Automation](https://docs.truestate.io/api-reference/automations/update-automation.md) - [Update Automation Metadata](https://docs.truestate.io/api-reference/automations/update-automation-metadata.md) - [Query a Chatbot with a single message](https://docs.truestate.io/api-reference/chatbots/query-a-chatbot-with-a-single-message.md): Handles chatbot queries with a single user message, without conversation history. - [Query a Chatbot with conversation history](https://docs.truestate.io/api-reference/chatbots/query-a-chatbot-with-conversation-history.md): Handles chatbot queries by incorporating conversation history. - [Check if backend is alive.](https://docs.truestate.io/api-reference/check-if-backend-is-alive.md): Returns `{"status":"ok"}` if backend is alive. Check [here](/status). Unlike most other endpoints, this one does not require authentication. - [Create a classification class hierarchy](https://docs.truestate.io/api-reference/classification-classes/create-a-classification-class-hierarchy.md) - [Delete an existing classification class hierarchy](https://docs.truestate.io/api-reference/classification-classes/delete-an-existing-classification-class-hierarchy.md) - [Get a list of all available classification class hierarchies](https://docs.truestate.io/api-reference/classification-classes/get-a-list-of-all-available-classification-class-hierarchies.md) - [Get an existing classification class hierarchy](https://docs.truestate.io/api-reference/classification-classes/get-an-existing-classification-class-hierarchy.md) - [Update a classification class hierarchy](https://docs.truestate.io/api-reference/classification-classes/update-a-classification-class-hierarchy.md) - [Check Convention Title Exists](https://docs.truestate.io/api-reference/conventions/check-convention-title-exists.md): Check if a convention with the given title already exists for the organization. - [Create Convention](https://docs.truestate.io/api-reference/conventions/create-convention.md): Create a new convention. - [Delete Convention](https://docs.truestate.io/api-reference/conventions/delete-convention.md): Delete a convention. - [Get Convention](https://docs.truestate.io/api-reference/conventions/get-convention.md): Get a specific convention by ID. - [Get Conventions](https://docs.truestate.io/api-reference/conventions/get-conventions.md): Get all conventions for the member's organization. - [Search Conventions](https://docs.truestate.io/api-reference/conventions/search-conventions.md): Search conventions using semantic similarity. - [Update Convention](https://docs.truestate.io/api-reference/conventions/update-convention.md): Update a convention. - [Create Conversation](https://docs.truestate.io/api-reference/conversations/create-conversation.md) - [Delete Conversation](https://docs.truestate.io/api-reference/conversations/delete-conversation.md) - [Generate Title](https://docs.truestate.io/api-reference/conversations/generate-title.md) - [Get Conversation](https://docs.truestate.io/api-reference/conversations/get-conversation.md) - [List Conversations](https://docs.truestate.io/api-reference/conversations/list-conversations.md) - [Stop Conversation](https://docs.truestate.io/api-reference/conversations/stop-conversation.md) - [Update Conversation](https://docs.truestate.io/api-reference/conversations/update-conversation.md) - [Get Auto Recharge Settings](https://docs.truestate.io/api-reference/credit-usage/get-auto-recharge-settings.md) - [Get Credit Usages](https://docs.truestate.io/api-reference/credit-usage/get-credit-usages.md) - [Get Credits](https://docs.truestate.io/api-reference/credit-usage/get-credits.md) - [Get Price Preview](https://docs.truestate.io/api-reference/credit-usage/get-price-preview.md) - [Purchase Credits](https://docs.truestate.io/api-reference/credit-usage/purchase-credits.md) - [Update Auto Recharge Settings](https://docs.truestate.io/api-reference/credit-usage/update-auto-recharge-settings.md) - [Create Dashboard](https://docs.truestate.io/api-reference/dashboards/create-dashboard.md) - [Delete Dashboard](https://docs.truestate.io/api-reference/dashboards/delete-dashboard.md) - [Fetch Query Result](https://docs.truestate.io/api-reference/dashboards/fetch-query-result.md) - [Get Dashboard](https://docs.truestate.io/api-reference/dashboards/get-dashboard.md) - [Get Dashboards](https://docs.truestate.io/api-reference/dashboards/get-dashboards.md) - [Run Data For Visualisation](https://docs.truestate.io/api-reference/dashboards/run-data-for-visualisation.md) - [Update Dashboard](https://docs.truestate.io/api-reference/dashboards/update-dashboard.md) - [Validate Data Source](https://docs.truestate.io/api-reference/dashboards/validate-data-source.md) - [Get Data Dictionary](https://docs.truestate.io/api-reference/data-dictionary/get-data-dictionary.md): Get the current version of a dataset - [Update Data Dictionary](https://docs.truestate.io/api-reference/data-dictionary/update-data-dictionary.md) - [Execute Query](https://docs.truestate.io/api-reference/data/execute-query.md) - [Delete Dataset](https://docs.truestate.io/api-reference/datasets/delete-dataset.md) - [Get a signed URL to download the dataset](https://docs.truestate.io/api-reference/datasets/get-a-signed-url-to-download-the-dataset.md): Provides a signed URL to download the dataset file - [Get Dataset](https://docs.truestate.io/api-reference/datasets/get-dataset.md): Get the current version of a dataset - [Get Datasets](https://docs.truestate.io/api-reference/datasets/get-datasets.md) - [Handle completion of dataset upload](https://docs.truestate.io/api-reference/datasets/handle-completion-of-dataset-upload.md) - [New Sync Dataset](https://docs.truestate.io/api-reference/datasets/new-sync-dataset.md) - [Run Sync Dataset](https://docs.truestate.io/api-reference/datasets/run-sync-dataset.md) - [Update Dataset](https://docs.truestate.io/api-reference/datasets/update-dataset.md) - [Upload Dataset](https://docs.truestate.io/api-reference/datasets/upload-dataset.md) - [Upsert Dataset](https://docs.truestate.io/api-reference/datasets/upsert-dataset.md) - [Create Deployment](https://docs.truestate.io/api-reference/deployments/create-deployment.md) - [Delete an existing deployment](https://docs.truestate.io/api-reference/deployments/delete-an-existing-deployment.md) - [Get Deployments](https://docs.truestate.io/api-reference/deployments/get-deployments.md): Fetch all the deployments - [Create Document Upload](https://docs.truestate.io/api-reference/documents/create-document-upload.md) - [Delete Document](https://docs.truestate.io/api-reference/documents/delete-document.md) - [Document Upload Complete](https://docs.truestate.io/api-reference/documents/document-upload-complete.md) - [Get Document](https://docs.truestate.io/api-reference/documents/get-document.md) - [List Documents](https://docs.truestate.io/api-reference/documents/list-documents.md) - [Update Document](https://docs.truestate.io/api-reference/documents/update-document.md) - [Generate embeddings for sentences](https://docs.truestate.io/api-reference/inference/generate-embeddings-for-sentences.md) - [Transcribe audio using Whisper](https://docs.truestate.io/api-reference/inference/transcribe-audio-using-whisper.md): Transcribe audio file using OpenAI's Whisper model. Accepts audio files in various formats (mp3, wav, m4a, webm, etc.) - [Create Message](https://docs.truestate.io/api-reference/messages/create-message.md) - [Get Messages](https://docs.truestate.io/api-reference/messages/get-messages.md) - [Update Message](https://docs.truestate.io/api-reference/messages/update-message.md): Update an existing message's text and *is_finished* flag. The caller must own the message (matched by member_id). Only the 'message' and 'is_finished' fields are applied on update; other fields are ignored to keep the payload schema reusable. - [Get Figure By Path](https://docs.truestate.io/api-reference/models/get-figure-by-path.md): Retrieves the figure.png file from a given GCS URI provided directly in the path. - [Get Model](https://docs.truestate.io/api-reference/models/get-model.md) - [Get Models](https://docs.truestate.io/api-reference/models/get-models.md) - [Query Deployment](https://docs.truestate.io/api-reference/models/query-deployment.md) - [Activate New Service Session](https://docs.truestate.io/api-reference/notebook-services/activate-new-service-session.md) - [Create Service](https://docs.truestate.io/api-reference/notebook-services/create-service.md) - [Get Api Kernel](https://docs.truestate.io/api-reference/notebook-services/get-api-kernel.md) - [Get Api Kernels](https://docs.truestate.io/api-reference/notebook-services/get-api-kernels.md) - [Get Api Kernelspecs](https://docs.truestate.io/api-reference/notebook-services/get-api-kernelspecs.md) - [Get Api Me](https://docs.truestate.io/api-reference/notebook-services/get-api-me.md) - [Get Api Sessions](https://docs.truestate.io/api-reference/notebook-services/get-api-sessions.md) - [Get Service Sessions](https://docs.truestate.io/api-reference/notebook-services/get-service-sessions.md) - [Interrupt Api Kernel](https://docs.truestate.io/api-reference/notebook-services/interrupt-api-kernel.md) - [Is Service Running](https://docs.truestate.io/api-reference/notebook-services/is-service-running.md) - [Patch Api Sessions](https://docs.truestate.io/api-reference/notebook-services/patch-api-sessions.md) - [Post Api Sessions](https://docs.truestate.io/api-reference/notebook-services/post-api-sessions.md) - [Restart Api Kernel](https://docs.truestate.io/api-reference/notebook-services/restart-api-kernel.md) - [Create Notebook](https://docs.truestate.io/api-reference/notebooks/create-notebook.md) - [Delete Notebook](https://docs.truestate.io/api-reference/notebooks/delete-notebook.md) - [Get Notebook](https://docs.truestate.io/api-reference/notebooks/get-notebook.md) - [Get Notebooks](https://docs.truestate.io/api-reference/notebooks/get-notebooks.md) - [Update Notebook](https://docs.truestate.io/api-reference/notebooks/update-notebook.md) - [Assign Or Create Organisation](https://docs.truestate.io/api-reference/organisations/assign-or-create-organisation.md) - [Create Member](https://docs.truestate.io/api-reference/organisations/create-member.md) - [Create Organisation](https://docs.truestate.io/api-reference/organisations/create-organisation.md) - [Delete Organisation Business Model Canvas](https://docs.truestate.io/api-reference/organisations/delete-organisation-business-model-canvas.md) - [Delete Organisation Ontology](https://docs.truestate.io/api-reference/organisations/delete-organisation-ontology.md) - [Delete Organisation Value Chain](https://docs.truestate.io/api-reference/organisations/delete-organisation-value-chain.md) - [Get Current Organisation](https://docs.truestate.io/api-reference/organisations/get-current-organisation.md) - [Get Members](https://docs.truestate.io/api-reference/organisations/get-members.md) - [Get Organisation](https://docs.truestate.io/api-reference/organisations/get-organisation.md) - [Get Organisation Business Model Canvas](https://docs.truestate.io/api-reference/organisations/get-organisation-business-model-canvas.md) - [Get Organisation Context](https://docs.truestate.io/api-reference/organisations/get-organisation-context.md) - [Get Organisation Ontology](https://docs.truestate.io/api-reference/organisations/get-organisation-ontology.md) - [Get Organisation Report Header](https://docs.truestate.io/api-reference/organisations/get-organisation-report-header.md) - [Get Organisation Value Chain](https://docs.truestate.io/api-reference/organisations/get-organisation-value-chain.md) - [Get Organisations](https://docs.truestate.io/api-reference/organisations/get-organisations.md) - [Put Organisation Business Model Canvas](https://docs.truestate.io/api-reference/organisations/put-organisation-business-model-canvas.md) - [Put Organisation Ontology](https://docs.truestate.io/api-reference/organisations/put-organisation-ontology.md) - [Put Organisation Value Chain](https://docs.truestate.io/api-reference/organisations/put-organisation-value-chain.md) - [Remove Member](https://docs.truestate.io/api-reference/organisations/remove-member.md) - [Sets Seats Num](https://docs.truestate.io/api-reference/organisations/sets-seats-num.md) - [Toggle Seat Renewal](https://docs.truestate.io/api-reference/organisations/toggle-seat-renewal.md) - [Update Organisation](https://docs.truestate.io/api-reference/organisations/update-organisation.md) - [Update Organisation Context](https://docs.truestate.io/api-reference/organisations/update-organisation-context.md) - [Update Organisation Report Header](https://docs.truestate.io/api-reference/organisations/update-organisation-report-header.md) - [Update Permissions](https://docs.truestate.io/api-reference/organisations/update-permissions.md) - [Upgrade Or Renew Subscription](https://docs.truestate.io/api-reference/organisations/upgrade-or-renew-subscription.md) - [Confirm Setup Intent](https://docs.truestate.io/api-reference/payment-methods/confirm-setup-intent.md): Updates the customer's billing details and attaches the new payment method - [Create Payment Method](https://docs.truestate.io/api-reference/payment-methods/create-payment-method.md): Creates a secret from stripe to send to the frontend that allows the customer to talk directly to stripe. - [Delete Payment Method](https://docs.truestate.io/api-reference/payment-methods/delete-payment-method.md): Remove the organisation's current default payment method. - [Get Payment Method](https://docs.truestate.io/api-reference/payment-methods/get-payment-method.md) - [Cancel Pipeline Run](https://docs.truestate.io/api-reference/pipeline-runs/cancel-pipeline-run.md) - [Create Pipeline Run](https://docs.truestate.io/api-reference/pipeline-runs/create-pipeline-run.md) - [Get Run](https://docs.truestate.io/api-reference/pipeline-runs/get-run.md) - [Get Run Logs](https://docs.truestate.io/api-reference/pipeline-runs/get-run-logs.md) - [Get Runs](https://docs.truestate.io/api-reference/pipeline-runs/get-runs.md) - [Create Pipeline](https://docs.truestate.io/api-reference/pipelines/create-pipeline.md): Create a new pipeline. - [Delete Pipeline](https://docs.truestate.io/api-reference/pipelines/delete-pipeline.md): Delete a specific pipeline. - [Duplicate Pipeline](https://docs.truestate.io/api-reference/pipelines/duplicate-pipeline.md) - [Get Pipeline](https://docs.truestate.io/api-reference/pipelines/get-pipeline.md): Retrieve a specific pipeline by ID. - [Get Pipeline Versions](https://docs.truestate.io/api-reference/pipelines/get-pipeline-versions.md) - [Get Pipelines](https://docs.truestate.io/api-reference/pipelines/get-pipelines.md): Retrieve all pipelines associated with the user's organization. - [Transfer Pipeline Between Organisations](https://docs.truestate.io/api-reference/pipelines/transfer-pipeline-between-organisations.md) - [Update Pipeline](https://docs.truestate.io/api-reference/pipelines/update-pipeline.md) - [Update Pipeline Metadata](https://docs.truestate.io/api-reference/pipelines/update-pipeline-metadata.md) - [Update Pipeline Schedule](https://docs.truestate.io/api-reference/pipelines/update-pipeline-schedule.md) - [Create Report](https://docs.truestate.io/api-reference/reports/create-report.md) - [Delete Report](https://docs.truestate.io/api-reference/reports/delete-report.md) - [Get Report](https://docs.truestate.io/api-reference/reports/get-report.md) - [Get Report Pdf](https://docs.truestate.io/api-reference/reports/get-report-pdf.md): Generate PDF of report with all images embedded as base64 and a footer link. - [Get Reports](https://docs.truestate.io/api-reference/reports/get-reports.md) - [Update Report](https://docs.truestate.io/api-reference/reports/update-report.md) - [Create a new secret entry in the DB. These are typically used/needed to access datasets in protected cloud storage.](https://docs.truestate.io/api-reference/secrets/create-a-new-secret-entry-in-the-db-these-are-typically-usedneeded-to-access-datasets-in-protected-cloud-storage.md): Create a new secret entry in the database. - [Delete an existing secret entry in the DB. This will also delete the associated secret in the cloud provider's secret manager.](https://docs.truestate.io/api-reference/secrets/delete-an-existing-secret-entry-in-the-db-this-will-also-delete-the-associated-secret-in-the-cloud-providers-secret-manager.md): Delete an existing secret entry in the database. - [Retrieve all secrets for an organization.](https://docs.truestate.io/api-reference/secrets/retrieve-all-secrets-for-an-organization.md): Get all secrets for the current user's organization. - [Retrieve metadata for a secret](https://docs.truestate.io/api-reference/secrets/retrieve-metadata-for-a-secret.md): Get the metadata for a specific secret. - [Create a tagging list](https://docs.truestate.io/api-reference/tagging-lists/create-a-tagging-list.md) - [Delete an existing tagging list](https://docs.truestate.io/api-reference/tagging-lists/delete-an-existing-tagging-list.md) - [Get a list of all available tagging lists](https://docs.truestate.io/api-reference/tagging-lists/get-a-list-of-all-available-tagging-lists.md) - [Get an existing tagging list](https://docs.truestate.io/api-reference/tagging-lists/get-an-existing-tagging-list.md) - [Update a tagging list](https://docs.truestate.io/api-reference/tagging-lists/update-a-tagging-list.md) - [Create Template](https://docs.truestate.io/api-reference/task-templates/create-template.md) - [Delete Template](https://docs.truestate.io/api-reference/task-templates/delete-template.md) - [Get Template](https://docs.truestate.io/api-reference/task-templates/get-template.md) - [List Templates](https://docs.truestate.io/api-reference/task-templates/list-templates.md) - [Run Template Now](https://docs.truestate.io/api-reference/task-templates/run-template-now.md) - [Update Template](https://docs.truestate.io/api-reference/task-templates/update-template.md) - [Update Template Schedule](https://docs.truestate.io/api-reference/task-templates/update-template-schedule.md) - [Assign Task](https://docs.truestate.io/api-reference/tasks/assign-task.md) - [Cancel Task](https://docs.truestate.io/api-reference/tasks/cancel-task.md) - [Create And Assign Task](https://docs.truestate.io/api-reference/tasks/create-and-assign-task.md): Create a task then immediately dispatch it to the assigned agent. - [Create Task](https://docs.truestate.io/api-reference/tasks/create-task.md) - [Delete Task](https://docs.truestate.io/api-reference/tasks/delete-task.md) - [Get Task](https://docs.truestate.io/api-reference/tasks/get-task.md) - [Get Tasks](https://docs.truestate.io/api-reference/tasks/get-tasks.md): if no group_id provided, get the top-level tasks i.e. task.group_id == task.id else get all tasks in the group - [Update Task](https://docs.truestate.io/api-reference/tasks/update-task.md) - [Read User Context](https://docs.truestate.io/api-reference/user-context/read-user-context.md) - [Upsert User Context](https://docs.truestate.io/api-reference/user-context/upsert-user-context.md) - [Get User](https://docs.truestate.io/api-reference/user/get-user.md) - [Home](https://docs.truestate.io/getting_started/introduction.md) - [Loading Data](https://docs.truestate.io/getting_started/loading-data.md) - [Pricing](https://docs.truestate.io/getting_started/pricing.md) - [Quickstart Guide](https://docs.truestate.io/getting_started/quickstart.md): Get started with AI-driven analytics in under 5 minutes - [API Keys](https://docs.truestate.io/guides/api-keys.md) - [Billing](https://docs.truestate.io/guides/billing.md): Plans, invoices, and payments - [Chat](https://docs.truestate.io/guides/chat.md) - [Conventions](https://docs.truestate.io/guides/conventions.md) - [Custom Assistants](https://docs.truestate.io/guides/custom-assistants.md) - [Dashboards](https://docs.truestate.io/guides/dashboards.md) - [Datasets](https://docs.truestate.io/guides/datasets.md) - [Organisations and Users](https://docs.truestate.io/guides/organisations-and-users.md) - [Pipelines](https://docs.truestate.io/guides/pipelines.md) - [Reports](https://docs.truestate.io/guides/reports.md) - [Secrets](https://docs.truestate.io/guides/secrets.md) ## OpenAPI Specs - [openapi](https://docs.truestate.io/api-reference/openapi.json)