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

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