Reference

API reference

Explore the contract-derived Permute REST API reference with authenticated request examples, response examples, and TypeScript SDK usage.

1.0.0-beta Version98 EndpointsOpenAPI JSON

Workspaces

GETList workspaces/v1/workspacesPOSTCreate a workspace/v1/workspacesGETGet a workspace/v1/workspaces/{workspaceId}PATCHUpdate a workspace/v1/workspaces/{workspaceId}DELETEDelete a workspace/v1/workspaces/{workspaceId}

Sources

GETList queryable sources/v1/sourcesGETGet a source/v1/sources/{sourceId}

Connector sessions

POSTCreate a hosted connector session/v1/connector-sessionsGETGet hosted connector session status/v1/connector-sessions/{sessionId}

Actions

GETList business actions/v1/actionsPOSTCreate a business action/v1/actionsGETGet a business action/v1/actions/{actionId}DELETEDelete a business action/v1/actions/{actionId}GETGet action definitions/v1/actions/{actionId}/definitionPUTSave an action draft/v1/actions/{actionId}/definitionPOSTInvoke a published action/v1/actions/{actionId}/invoke

Chats

POSTStart a conversation/v1/chatsGETRead a conversation/v1/chats/{chatId}POSTSend a message/v1/chats/{chatId}/turnsPOSTStop generation/v1/chats/{chatId}/stopPOSTConfirm or dismiss an action proposal/v1/chats/{chatId}/decisions

Identity

GETRead your basic profile/v1/me

Dashboards

GETGet dashboard source/v1/dashboards/{dashboardId}/sourcePUTUpdate dashboard source/v1/dashboards/{dashboardId}/source

Datasets

POSTCreate a dataset/v1/datasetsGETGet a dataset by key/v1/datasetsGETGet a dataset/v1/datasets/{datasetId}GETDownload a file dataset/v1/datasets/{datasetId}/downloadDELETEDelete a dataset/v1/datasets/{datasetId}POSTWrite dataset tables/v1/datasets/{datasetId}/tables

Search

POSTSearch business evidence/v1/search

Answers

POSTStart an answer job/v1/answer-jobsGETGet an answer job/v1/answer-jobs/{answerJobId}

Queries

POSTRun a structured query/v1/queries

Operations

GETList operation runs by workflow/v1/operation-runsGETList operations/v1/operationsGETGet an operation/v1/operations/{operationId}PATCHSchedule, pause, or resume an operation/v1/operations/{operationId}GETRead operation code and inputs/v1/operations/{operationId}/sourcePUTSave operation code as a draft/v1/operations/{operationId}/sourceGETList the latest 50 operation runs/v1/operations/{operationId}/runsGETInspect a completed run before publishing/v1/operations/{operationId}/runs/{runId}/outputPOSTRun an operation or data flow/v1/operations/{operationId}/runs

Data Flows

POSTCreate a draft data flow/v1/data-flowsGETGet a data flow and its operation references/v1/data-flows/{dataFlowId}POSTEdit or publish a data flow/v1/data-flows/{dataFlowId}/commands

Facts

GETList organization facts/v1/factsGETGet a fact/v1/facts/{factId}POSTCreate a fact/v1/factsPUTReplace a fact/v1/facts/{factId}DELETEDelete a fact/v1/facts/{factId}

Skills

GETList shared skills/v1/skillsGETRead a skill/v1/skills/{path}PUTCreate or replace a skill/v1/skills/{path}DELETEDelete a skill/v1/skills/{path}GETList shared organization skills/v1/organization/skillsGETRead an organization skill/v1/organization/skills/{path}PUTCreate or replace an organization skill/v1/organization/skills/{path}DELETEDelete an organization skill/v1/organization/skills/{path}

Databases

GETList databases/v1/databasesPOSTCreate a managed database/v1/databasesGETGet a database/v1/databases/{databaseId}DELETEDelete a database/v1/databases/{databaseId}GETGet draft and published database definitions/v1/databases/{databaseId}/definitionPUTSave a database schema draft/v1/databases/{databaseId}/definitionGETList database tables/v1/databases/{databaseId}/tablesPOSTAdd a table to the database schema draft/v1/databases/{databaseId}/tablesGETRead database records/v1/databases/{databaseId}/tables/{table}/recordsPOSTAdmin record transaction/v1/databases/{databaseId}/transactions

Apps

GETRead an app source file/v1/apps/{applicationId}/source-fileGETGet an app custom address/v1/apps/{applicationId}/addressPUTSet an app custom address/v1/apps/{applicationId}/addressGETGet app access settings/v1/apps/{applicationId}/accessPUTSet app access settings/v1/apps/{applicationId}/accessGETList app resource grants/v1/apps/{applicationId}/grantsPUTSet or revoke an app resource grant/v1/apps/{applicationId}/grants/{resourceId}GETList apps/v1/appsPOSTCreate an app/v1/appsGETGet an app/v1/apps/{applicationId}PATCHUpdate app settings/v1/apps/{applicationId}POSTPrepare app file uploads/v1/apps/{applicationId}/uploadsPUTSave app source and an optional compiled site/v1/apps/{applicationId}/siteDELETEDelete an app/v1/apps/{applicationId}

Versioning

GETRead resource history and version state/v1/resources/{resourceId}/revisionsGETRead a complete historical revision/v1/resources/{resourceId}/revisions/{revisionId}POSTRestore a revision as the current draft/v1/resources/{resourceId}/revisions/{revisionId}/restorePOSTPublish the current resource draft/v1/resources/{resourceId}/publish

Write syncs

GETList write syncs/v1/write-syncsPOSTCreate a write sync/v1/write-syncsGETDiscover writable destinations/v1/write-syncs/destinationsGETGet a write sync/v1/write-syncs/{writeSyncId}PUTUpdate a write sync/v1/write-syncs/{writeSyncId}DELETEDelete a write sync/v1/write-syncs/{writeSyncId}POSTTest a write sync/v1/write-syncs/{writeSyncId}/previewPOSTPause a write sync/v1/write-syncs/{writeSyncId}/pauseGETList write sync runs/v1/write-syncs/{writeSyncId}/runsGETInspect write sync results/v1/write-syncs/{writeSyncId}/runs/{runId}POSTExecute a write sync now/v1/write-syncs/{writeSyncId}/runs/{runId}/execute