API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Data

Ingest data for fraud detection and risk analysis.

Add data

POST/v1/data/{namespace}

Create upload URL

POST/v1/data/{namespace}/requests/upload-url

Get request status and inline results

GET/v1/data/{namespace}/requests/{requestId}

Get download URL

GET/v1/data/{namespace}/requests/{requestId}/results/download-url

Update namespace settings

PUT/v1/data/{namespace}/settings

ModelsExpand Collapse

DataAddResponse object { requestId, status }

Response confirming data was accepted for asynchronous processing. The requestId can be used for debugging and tracking.

requestId: string

Unique identifier for tracking this request. Data processing happens asynchronously after this response.

status: "accepted"

Request was accepted for processing

DataCreateUploadURLResponse object { expires_at, objectKey, requestId, 2 more }

Response containing an upload URL and metadata for large-batch file processing. Use PUT {upload_url} to upload JSONL (one JSON object per line). upload_url expires in 12 hours.

expires_at: string

ISO timestamp when upload_url expires (12 hours after issuance)

objectKey: string

S3 object key where uploaded JSONL will be processed from

requestId: string

Unique identifier for this upload request

status: "pending_upload"

Request is waiting for file upload

upload_url: string

Pre-signed upload URL for PUT-ing JSONL content (Content-Type: application/json)

DataGetStatusResponse object { data, namespace, request_id, status }

Response containing request status and processed output data. Before processing completes, data is an empty array. If the processed output exceeds the 5 MiB inline response limit, this endpoint returns an error instructing you to use the results download URL endpoint instead.

data: array of object { id, output, url, metadata }

id: string

Object identifier from the ingested data

output: object { actions, fields, labels }

actions: array of unknown

fields: map[unknown]

labels: array of object { label }

label: string

url: string

metadata: optional map[unknown]

namespace: string

request_id: string

status: "queued" or "uploading" or "ingesting" or 2 more

Current processing status of the request

One of the following:

"queued"

"uploading"

"ingesting"

"succeeded"

"failed"

DataGetDownloadURLResponse object { data_count, data_expires_at, data_url, 3 more }

Response containing request status and a temporary S3 URL for the full request result. The shape is stable across all request sizes; before processing completes, the download fields are null.

data_count: number

Number of processed objects in the request. Null until the request has succeeded.

minimum0

data_expires_at: string

ISO timestamp when data_url expires. Null until the request has succeeded.

data_url: string

Temporary S3 URL for the full request result. Null until the request has succeeded.

namespace: string

request_id: string

status: "queued" or "uploading" or "ingesting" or 2 more

Current processing status of the request

One of the following:

"queued"

"uploading"

"ingesting"

"succeeded"

"failed"

DataUpdateSettingsResponse object { namespace, status }

Namespace configuration was stored.

namespace: string

status: "updated"