assistants
api-keys
conversations
chatbots
data
data-dictionary
datasets
dashboards
credit_usage
dashboard-elements
dashboard-filters
dashboard-element-data
deployments
secrets
- GETRetrieve metadata for a secret
- DELDelete an existing secret entry in the DB. This will also delete the associated secret in the cloud provider's secret manager.
- GETRetrieve all secrets for an organization.
- POSTCreate a new secret entry in the DB. These are typically used/needed to access datasets in protected cloud storage.
workflows
live_flows
live_flow_sessions
classification-classes
- GETGet a list of all available classification class hierarchies
- POSTCreate a classification class hierarchy
- GETGet an existing classification class hierarchy
- DELDelete an existing classification class hierarchy
- PATCHUpdate a classification class hierarchy
- POSTCreate a classification class hierarchy from a CSV file
organisation
inference
tagging-lists
notebooks
- GETGet Notebooks
- POSTCreate Notebook
- GETGet Notebook
- DELDelete Notebook
- PATCHUpdate Notebook
- GETIs Service Running
- POSTCreate Service
- GETGet Service Sessions
- POSTActivate New Service Session
- GETGet Api Sessions
- POSTPost Api Sessions
- PATCHPatch Api Sessions
- GETGet Api Kernels
- GETGet Api Kernel
- POSTInterrupt Api Kernel
- POSTRestart Api Kernel
- GETGet Api Kernelspecs
- GETGet Api Me
admin-organisation
workflows
Get Workflow
Retrieve a specific workflow by ID.
Args:
- workflow_id: ID of the workflow to retrieve.
- db: Database session.
- user: Authenticated user.
Returns:
- WorkflowRead: The requested workflow.
GET
/
workflows
/
{workflow_id}
Copy
{
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"config": {
"job_type": "<string>",
"query_type": "sql",
"query": "<string>",
"input_datasets": [
"<string>"
],
"output_datasets": [
"<string>"
]
},
"created_at": "2023-11-07T05:31:56Z"
}
],
"step_transitions": [
{
"source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"created_at": "2023-11-07T05:31:56Z"
},
"workflow_runs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_config_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"argo_manifest": {},
"argo_metadata": {},
"workflow_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"config": {
"job_type": "<string>",
"query_type": "sql",
"query": "<string>",
"input_datasets": [
"<string>"
],
"output_datasets": [
"<string>"
]
},
"created_at": "2023-11-07T05:31:56Z"
}
],
"step_transitions": [
{
"source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"created_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
],
"cron_schedule": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Represents the current organisation ID for the user (example: 'org_u13TesTDumMyEe5P')
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Copy
{
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"config": {
"job_type": "<string>",
"query_type": "sql",
"query": "<string>",
"input_datasets": [
"<string>"
],
"output_datasets": [
"<string>"
]
},
"created_at": "2023-11-07T05:31:56Z"
}
],
"step_transitions": [
{
"source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"created_at": "2023-11-07T05:31:56Z"
},
"workflow_runs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_config_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"argo_manifest": {},
"argo_metadata": {},
"workflow_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"config": {
"job_type": "<string>",
"query_type": "sql",
"query": "<string>",
"input_datasets": [
"<string>"
],
"output_datasets": [
"<string>"
]
},
"created_at": "2023-11-07T05:31:56Z"
}
],
"step_transitions": [
{
"source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"created_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
],
"cron_schedule": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
Assistant
Responses are generated using AI and may contain mistakes.