Complete workspace setup

Finalizes onboarding by testing the connection, encrypting the URL, and persisting it to the internal database scoped to the user's active organization. Resets the semantic layer whitelist cache so new tables become queryable immediately.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

Length1 <= length

connectionId?string

Response Body

`application/json`

curl -X POST "http://localhost:3001/api/v1/onboarding/complete" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'

{
  "connectionId": "string",
  "dbType": "string",
  "maskedUrl": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string",
  "details": [
    null
  ]
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

Complete workspace setup

Request Body

Response Body

201application/json

400application/json

401application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`