POST
/
chat
curl --request POST \
  --url https://api.urldna.io/chat \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prompt": "<string>",
  "response_type": "MARKDOWN",
  "scan_id": "<string>",
  "json_output": {}
}'
[
  {
    "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

Body

application/json
​
prompt
string
required

The user-provided input message.

​
response_type
enum<string>
required

The format of the response. If set to 'JSON', 'json_output' must contain a valid JSON dictionary.

Available options:
MARKDOWN,
JSON
​
scan_id
string
required

The associated scan ID

​
json_output
object

A valid JSON dictionary containing structured response data. This is required if 'response_type' is 'JSON'.

Response

200
application/json
Chat object created
​
id
string

Unique identifier for the chat session.

​
chat_date
string

The timestamp when the chat session was created.

​
prompt
string

The user-provided input message.

​
response
string

The AI-generated response to the user's prompt.

​
response_type
enum<string>

The format of the response. If set to 'JSON', 'json_output' must contain a valid JSON dictionary.

Available options:
MARKDOWN,
JSON
​
scan_id
string

The associated scan ID

​
status
enum<string>

The current status of the chat request.

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

A valid JSON dictionary containing structured response data. This is required if 'response_type' is 'JSON'.