.card img{
  scale: 0.6;
}

/* Works on Firefox */
* {
  scrollbar-width: thin;
  scrollbar-color: #ffffff4d #303030;
}

/* Works on Chrome, Edge, and Safari */
*::-webkit-scrollbar {
  width: 12px;
}

*::-webkit-scrollbar-track {
  background: #303030;
}

*::-webkit-scrollbar-thumb {
  background-color: #ffffff4d;
  border-radius: 20px;
  border: 3px solid #303030;
}

Create a new chat object. This endpoint is only available for PREMIUM users.

Create Chat

Represents a user chat session, storing prompts, responses, and scan-related details.

The timestamp when the chat session was created.

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

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

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

ApiKeyAuth

Unauthorized - API key is missing or invalid.

Forbidden - User is authenticated but lacks required permissions (e.g., not PREMIUM).

Internal Server Error - Unexpected error occurred.

Create new chat object

urlDNA - Documentation

Introduction

Scan

Search

My Queries

Brand Monitor

Takedown

AI Playground

Welcome to the urlDNA API documentation. This API allows you to scan, analyze, and retrieve insights about URLs, helping to detect potential threats such as phishing, malware, and scams.

You can obtain your API key from your urlDNA account page.

Authentication

Understand how API usage is counted and what your daily limits are.

API Quotas & Limit

The urlDNA Python package allows you to interact with the URLDNA API for scanning and analyzing URLs. With this package, you can retrieve scan results, extract metadata, and detect potential threats. 

Python Package

Initiate a new scan request. The response will contain the Scan object. Processing time varies based on system load (typically between 30 seconds and 1 minute) before the full scan result becomes available.

Create Scan

Fetch the details of a specific scan. If the scan status is PENDING or RUNNING, all attributes (except the scan metadata) will be empty.

Get Scan

Search for existing scan results using a query string or CQL (see the Search documentation for more details).

Quickly assess whether a given URL is SAFE or MALICIOUS.

Fast Check

Provide feedback on the scan verdict. The feedback can either classify the scan as MALICIOUS or SAFE.

Scan Feedback

Fetch a list of user agents that can be used for scanning.

User Agents

Fetch a list of supported viewport dimensions for scans.

Viewports

Retrieve a list of query objects associated with the user.

Queries

Retrieve details of a specific query object by ID.

Get Query

Retrieve all scans that match the specified query filter.

Query Scans

Create a new query object. The request must include a name and a list of query filters.

Create Query

Update an existing query object. The request must include a name and a list of query filters.

Updated Query

Delete Query

Retrieve all brands associated with the user. This endpoint is only available for PREMIUM users.

Brands

Retrieve details of a specific chat object. This endpoint is only available for PREMIUM users.

Get Brand

Retrieve all scans associated with a specific brand. This endpoint is only available for PREMIUM users.

Brand Scans

Retrieve a list of all chat objects associated with the user. This endpoint is only available for PREMIUM users.

Chats

Get Chat

Delete a specific chat object. This endpoint is only available for PREMIUM users.

Delete Chats

Cyber Threat Intelligence

Security Operation Center

Brand Monitoring

urlDNA empowers your security operations by seamlessly integrating into your workflows for efficient analysis and triaging of suspicious URLs. Simplify your processes and enhance your defenses with our robust API. Visit our API Documentation to learn how to integrate urlDNA into your environment effortlessly. 

API Documentation

Endpoints

Create Chat

Authorizations

Body

Response