Skip to main content
POST
/
api
/
v1
/
session
Create Session
curl --request POST \
  --url https://api.example.com/api/v1/session
{
  "201": {},
  "500": {},
  "sessionId": {},
  "message": "<string>"
}

​
Overview

Creates a new session with an automatically generated UUID. Sessions are used to track the state of connector generation workflows, including discovery, scraping, and documentation processing.

​
Request

No request body is required. The session ID is automatically generated.

​
Response

​
sessionId
string (UUID)
required
The unique identifier for the created session
​
message
string
required
Confirmation message about the session creation

​
Example Response

{
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Session created successfully. Use this session_id in subsequent requests."
}

​
Status Codes

​
201
Created
Session created successfully
​
500
Internal Server Error
Unable to create session due to server error

​
Example Request

curl -X POST https://api.example.com/api/v1/session \
  -H "Content-Type: application/json"

​
Usage Notes

  • The session ID must be used in subsequent API calls to maintain state
  • Sessions store workflow data including discovery input, scrape results, and documentation
  • Use the returned sessionId in path parameters for other session endpoints

​
Error Responses

​
500 Internal Server Error

{
  "detail": "Unable to create session"
}
This error occurs when the database operation fails during session creation.

Build docs developers (and LLMs) love

Get started for freeTalk to us