Workbook | Documentation

post

Body

emailstring · emailRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/workbook/auth/login

POST /v1/workbook/auth/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

No content

Validate

get

Path parameters

tokenanyRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/workbook/auth/validate/{token}

GET /v1/workbook/auth/validate/{token} HTTP/1.1
Host: 
Accept: */*

No content

Logout

post

Logout from Workbook

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/workbook/auth/logout

POST /v1/workbook/auth/logout HTTP/1.1
Host: 
Accept: */*

No content

Read User Me

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/users/me

GET /v1/workbook/users/me HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "email": "text",
  "name": "text",
  "avatar_url": "text",
  "title": "text",
  "description": "text",
  "gender": "male",
  "interested_in": [
    "text"
  ],
  "social_links": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tier": "text",
  "joined_at": "text",
  "ws_id": "text",
  "role": "text",
  "ws": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get My Api Key

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/users/api_keys

GET /v1/workbook/users/api_keys HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "api_key": "text"
}

Read Notebooks

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

searchany ofOptional

stringOptional

or

nullOptional

sort_byany ofOptionalDefault: name

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/notebooks

GET /v1/workbook/notebooks HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "CURRENT",
      "settings": {
        "model": "text",
        "plan_model": "text",
        "language": "text",
        "data_instruction": ""
      },
      "avatar": "text",
      "agents": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "",
          "avatar": "",
          "model": "",
          "alias": "",
          "category": "",
          "content": "",
          "goal": "",
          "is_enabled": false,
          "is_pined": false
        }
      ],
      "workflows": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "",
          "avatar": "",
          "model": "",
          "alias": "",
          "category": "",
          "content": "",
          "goal": "",
          "is_enabled": false,
          "is_pined": false
        }
      ],
      "created_at": 1,
      "updated_at": 1,
      "source_amount": 1
    }
  ],
  "pagination": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Create Notebook

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/workbook/notebooks

POST /v1/workbook/notebooks HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 470

{
  "name": "Untitled",
  "settings": {
    "model": "text",
    "plan_model": "text",
    "language": "text",
    "data_instruction": ""
  },
  "avatar": "",
  "agents": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ],
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "name": "Untitled",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "text",
  "status": "CURRENT",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "avatar": "text",
  "agents": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ],
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ]
}

Read Notebook

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/notebooks/{notebook_id}

GET /v1/workbook/notebooks/{notebook_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "name": "Untitled",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "text",
  "status": "CURRENT",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "avatar": "text",
  "agents": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ],
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ]
}

Update Notebook

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/workbook/notebooks/{notebook_id}

PUT /v1/workbook/notebooks/{notebook_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 650

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "name": "Untitled",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "text",
  "status": "CURRENT",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "avatar": "text",
  "agents": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ],
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "name": "Untitled",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "text",
  "status": "CURRENT",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "avatar": "text",
  "agents": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ],
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "",
      "avatar": "",
      "model": "",
      "alias": "",
      "category": "",
      "content": "",
      "goal": "",
      "is_enabled": false,
      "is_pined": false
    }
  ]
}

Delete Notebook

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/workbook/notebooks/{notebook_id}

DELETE /v1/workbook/notebooks/{notebook_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Notebook Sources

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/notebooks/{notebook_id}/sources

GET /v1/workbook/notebooks/{notebook_id}/sources HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "data": "text",
    "type": "text",
    "file": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-12-17T00:36:10.648Z",
    "updated_at": "2025-12-17T00:36:10.648Z",
    "status": "CURRENT"
  }
]

Get Notebook Topics

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

Query parameters

statusany ofOptional

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/notebooks/{notebook_id}/topics

GET /v1/workbook/notebooks/{notebook_id}/topics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "data": "text",
    "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-12-17T00:36:10.648Z",
    "updated_at": "2025-12-17T00:36:10.648Z",
    "status": "CURRENT"
  }
]

Create Source

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

dataany ofRequired

stringOptional

or

nullOptional

typeany ofRequired

stringOptional

or

nullOptional

fileany ofOptional

or

nullOptional

notebook_idstring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/workbook/sources

POST /v1/workbook/sources HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "data": "text",
  "type": "text",
  "file": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "data": "text",
  "type": "text",
  "file": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "status": "CURRENT"
}

Read Source

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

source_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/sources/{notebook_id}/{source_id}

GET /v1/workbook/sources/{notebook_id}/{source_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "text",
  "type": "text",
  "file": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "status": "CURRENT"
}

Update Source

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

source_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

dataany ofOptional

stringOptional

or

nullOptional

typeany ofOptional

stringOptional

or

nullOptional

fileany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/workbook/sources/{notebook_id}/{source_id}

PUT /v1/workbook/sources/{notebook_id}/{source_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "data": "text",
  "type": "text",
  "file": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "data": "text",
  "type": "text",
  "file": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "status": "CURRENT"
}

Delete Source

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

source_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

delete

/v1/workbook/sources/{notebook_id}/{source_id}

DELETE /v1/workbook/sources/{notebook_id}/{source_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create Topic

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

namestringRequired

dataany ofRequired

stringOptional

or

nullOptional

notebook_idstring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/workbook/topics

POST /v1/workbook/topics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "name": "text",
  "data": "text",
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "text",
  "data": "text",
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "status": "CURRENT"
}

Read Topic

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

topic_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/workbook/topics/{notebook_id}/{topic_id}

GET /v1/workbook/topics/{notebook_id}/{topic_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "data": "text",
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "status": "CURRENT"
}

Update Topic

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

topic_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

namestringRequired

dataany ofOptional

stringOptional

or

nullOptional

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/workbook/topics/{notebook_id}/{topic_id}

PUT /v1/workbook/topics/{notebook_id}/{topic_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "name": "text",
  "data": "text",
  "status": "CURRENT"
}

{
  "name": "text",
  "data": "text",
  "notebook_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-17T00:36:10.648Z",
  "updated_at": "2025-12-17T00:36:10.648Z",
  "status": "CURRENT"
}

Delete Topic

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

notebook_idstring · uuidRequired

topic_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/workbook/topics/{notebook_id}/{topic_id}

DELETE /v1/workbook/topics/{notebook_id}/{topic_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Send Invitation Code Enterprise

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

ws_idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$

ws_namestringRequired

invitation_codestringRequired

team_sizestringRequired

emailstringRequired

user_fullnamestringRequired

from_workbookbooleanRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/workbook/workspaces/onboard/enterprise/invitation-code

POST /v1/workbook/workspaces/onboard/enterprise/invitation-code HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "ws_id": "text",
  "ws_name": "text",
  "invitation_code": "text",
  "team_size": "text",
  "email": "text",
  "user_fullname": "text",
  "from_workbook": true
}

No content

Validate Email Invite

get

Path parameters

tokenstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/workbook/workspaces/onboard/enterprise/validate/{token}

GET /v1/workbook/workspaces/onboard/enterprise/validate/{token} HTTP/1.1
Host: 
Accept: */*

No content

Create

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$

namestringRequired

invitation_codeany ofOptionalDefault: ""

stringOptional

or

nullOptional

org_namestringRequired

team_sizestringRequired

occupationstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/workbook/workspaces/onboard/enterprise

POST /v1/workbook/workspaces/onboard/enterprise HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "id": "text",
  "name": "text",
  "invitation_code": "",
  "org_name": "text",
  "team_size": "text",
  "occupation": "text"
}

No content

Preflight Handler

options

Responses

200

Successful Response

application/json

Responseany

options

/v1/workbook/workspaces/onboard/enterprise

OPTIONS /v1/workbook/workspaces/onboard/enterprise HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Update Workspace

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$

namestringRequired

invitation_codeany ofOptionalDefault: ""

stringOptional

or

nullOptional

org_namestringRequired

team_sizestringRequired

occupationstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/workbook/workspaces

POST /v1/workbook/workspaces HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "id": "text",
  "name": "text",
  "invitation_code": "",
  "org_name": "text",
  "team_size": "text",
  "occupation": "text"
}

No content

Invite

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

emailsstring · email[]Required

workspace_idstringRequired

is_mobileany ofOptionalDefault: false

booleanOptional

or

nullOptional

roleany ofRequired

stringOptional

or

nullOptional

app_permissionsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/workbook/workspaces/members/invite

POST /v1/workbook/workspaces/members/invite HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "emails": [
    "[email protected]"
  ],
  "workspace_id": "text",
  "is_mobile": false,
  "role": "text",
  "app_permissions": [
    "text"
  ]
}

No content

Get Workspace Members

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptional

stringOptional

or

nullOptional

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/workbook/workspaces/members

GET /v1/workbook/workspaces/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Login

Validate

Logout

Read User Me

Get My Api Key

Read Notebooks

Create Notebook

Read Notebook

Update Notebook

Delete Notebook

Get Notebook Sources

Get Notebook Topics

Create Source

Read Source

Update Source

Delete Source

Create Topic

Read Topic

Update Topic

Delete Topic

Send Invitation Code Enterprise

Validate Email Invite

Create

Preflight Handler

Update Workspace

Invite

Get Workspace Members