Skip to main content
GET
/
api
/
v1
/
session
/
{session_id}
Get Session
curl --request GET \
  --url https://api.example.com/api/v1/session/{session_id}
{
  "200": {},
  "404": {},
  "sessionId": {},
  "data": {
    "discoveryInput": {
      "applicationName": "<string>",
      "applicationVersion": "<string>"
    },
    "scrapeInput": {
      "applicationName": "<string>",
      "applicationVersion": "<string>"
    },
    "documentationItems": [
      {}
    ]
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

​
Overview

Retrieves complete session data including metadata, stored configuration, and timestamps. Sessions contain all state information for connector generation workflows.

​
Path Parameters

​
session_id
string (UUID)
required
The unique identifier of the session to retrieve

​
Response

​
sessionId
string (UUID)
required
The unique identifier for the session
​
data
object
required
The session data stored as a dictionary. Contains workflow-specific information.
​
createdAt
string
required
Timestamp when the session was created (ISO 8601 format)
​
updatedAt
string
required
Timestamp when the session was last updated (ISO 8601 format)

​
Example Response

{
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "data": {
    "discoveryInput": {
      "applicationName": "My API",
      "applicationVersion": "v2.0"
    },
    "documentationItems": [],
    "scrapeInput": {
      "applicationName": "My API",
      "applicationVersion": "v2.0",
      "baseUrl": "https://api.example.com"
    }
  },
  "createdAt": "2026-03-10T10:30:00Z",
  "updatedAt": "2026-03-10T10:35:00Z"
}

​
Status Codes

​
200
OK
Session data retrieved successfully
​
404
Not Found
Session not found

​
Example Request

curl -X GET https://api.example.com/api/v1/session/123e4567-e89b-12d3-a456-426614174000 \
  -H "Content-Type: application/json"

​
Error Responses

​
404 Not Found

{
  "detail": "Session 123e4567-e89b-12d3-a456-426614174000 not found"
}
This error occurs when the specified session ID does not exist in the database.

​
Usage Notes

  • Sessions persist all workflow state including discovery results, scrape data, and documentation
  • The data field is a flexible dictionary that can contain any workflow-specific information
  • Sessions are created via the Create Session endpoint
  • Use Update Session to modify session data

Build docs developers (and LLMs) love

Get started for freeTalk to us