Skip to content

API Overview

Base URL for the hosted instance: https://demo.questa-ai.online

Authentication

DeploymentMethodHeader
Hosted demoEvaluation API tokenAuthorization: Bearer <token>
Self-hosted (production)Commercial license keyNone required

Endpoints

MethodPathDescription
GET/Welcome message
GET/healthHealth check
POST/anonymize/textAnonymize plain text (synchronous)
POST/anonymize/pdfAnonymize PDF (async)
POST/anonymize/docxAnonymize Word document (async)
POST/anonymize/csvAnonymize CSV (async)
POST/anonymize/excelAnonymize Excel file (async)
GET/anonymize/status/{job_id}Poll job status and retrieve result
GET/anonymize/entitiesList detectable entity types

Try any of these live (desktop). The API Playground docked on the right lets you set your API key once and pick any endpoint from the dropdown — and copy the equivalent cURL for any request. Collapse it with the arrow; reopen it from the Playground tab on the edge. (On mobile, use the cURL and code samples below.)

Content Types

EndpointContent-Type
POST /anonymize/textapplication/json
POST /anonymize/{type}multipart/form-data
GET /anonymize/status/{job_id}
GET /anonymize/entities

Common Parameters

ParameterTypeLocationRequiredDescription
textstringJSON bodyYes (text)Text to anonymize
entitiesstringBody/FormNoComma-separated entity type names
start_indexintBody/FormNoStarting placeholder index (default: 0)
custom_entitiesarray/stringBody/FormNoCustom entity definitions
filefileFormYes (file)File to anonymize
job_idstringPathYes (status)Job ID from file upload

CORS

The hosted API sets Access-Control-Allow-Origin: * and allows all methods and headers, so browser-based requests work from any domain. Self-hosted instances are configured the same way by default — see the Self-Hosting guide to restrict CORS for production.

Standard Response Codes

CodeDescription
200Success (text anonymization)
202Accepted (file processing started)
400Bad request
401Unauthorized
403Evaluation request limit reached
404Job not found
429Rate limit exceeded
500Internal server error

Questa AI documentation.