Skip to main content
GET
/
v1
/
chat
/
{chat_id}
Get Chat Session Details
curl --request GET \
  --url https://api.urldna.io/v1/chat/{chat_id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "chat_date": "2023-11-07T05:31:56Z",
  "prompt": "<string>",
  "response": "<string>",
  "response_type": "MARKDOWN",
  "scan_id": "<string>",
  "status": "PENDING",
  "json_output": {}
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
chat_id
string
required

Unique chat session identifier.

Response

Chat details retrieved successfully.

AI chat session for analyzing scan results, generating insights, and extracting structured data from scans.

​
id
string

Unique chat session identifier.

​
chat_date
string<date-time>

ISO 8601 timestamp when the chat session was initiated.

​
prompt
string

User's input message or question about the scan.

​
response
string

AI-generated response to the user's prompt.

​
response_type
enum<string>

Response format: MARKDOWN for human-readable text or JSON for structured data extraction.

Available options:
MARKDOWN,
JSON
​
scan_id
string

Associated scan identifier for context.

​
status
enum<string>

Chat processing status.

Available options:
PENDING,
RUNNING,
DONE,
ERROR
​
json_output
object

Structured JSON data when response_type is JSON. Must contain a valid dictionary.