Skip to main content
POST
/
api
/
v3
/
workspaces
Create a workspace
curl --request POST \
  --url https://api.lighton.ai/api/v3/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": ""
}
'
import requests

url = "https://api.lighton.ai/api/v3/workspaces"

payload = {
    "name": "<string>",
    "description": ""
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: ''})
};

fetch('https://api.lighton.ai/api/v3/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lighton.ai/api/v3/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lighton.ai/api/v3/workspaces"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.lighton.ai/api/v3/workspaces")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.lighton.ai/api/v3/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "workspace_type": "<string>",
  "document_upload_method": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "files_count": 123,
  "used_storage": 123,
  "summaries": [
    {
      "language": "<string>",
      "summary": "<string>"
    }
  ],
  "sync": {
    "datasource_type": "<string>",
    "source_name": "<string>",
    "last_status": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "failed_files_count": 123,
    "next_import_date": "2023-11-07T05:31:56Z",
    "editable": true,
    "name": "<string>",
    "instance_url": "<string>",
    "tenant_id": "<string>",
    "site_name": "<string>",
    "client_id": "<string>",
    "filter_criteria": "<unknown>"
  },
  "scoped_api_keys": [
    {
      "id": "<string>",
      "name": "<string>",
      "prefix": "<string>",
      "role": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

V3 Request serializer for creating a workspace in the user's company.

name
string
required
Maximum string length: 100
description
string
default:""

Response

Workspace created successfully

V3 Response serializer for company workspace creation and retrieval.

id
integer
required
name
string
required
workspace_type
string
required
document_upload_method
string
required
description
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
files_count
integer
required
user_role
required
  • owner - owner
  • editor - editor
  • viewer - viewer
  • `` -
Available options:
owner,
editor,
viewer
used_storage
number<double>
required
summaries
object[]
required
read-only
sync
object | null
required
scoped_api_keys
object[]
required
read-only