Skip to guide
Documentation/API reference

API reference.

What to send to the Backgrounder API and what it sends back.

01

Endpoints

POST /api/analyze-content

GET /api/analyze-content/{id}

GET /api/jobs/{id}

GET /api/jobs/{id}/result

GET /api/reports/{jobId}?format=json|pdf|html

Carmen API

Endpoints

POST /api/analyze-content
GET /api/analyze-content/{id}
GET /api/jobs/{id}
GET /api/jobs/{id}/result
GET /api/reports/{jobId}?format=json|pdf|html
Endpoints.
02

Request fields

case.{id,name,description}

content.{text,context}

options.{sync,createCase,reportFormats[],priority}

metadata

files (multipart)

Carmen API

Request fields

case.{id,name,description}
content.{text,context}
options.{sync,createCase,reportFormats[],priority}
metadata
files (multipart)
Request fields.
03

Response fields

job_id

status

mode

search_type

case_id

case_created

result{verdict, confidence, headline, recommended_action, evidence_trail[], context_insights}

Carmen API

Response fields

job_id
status
mode
search_type
case_id
case_created
result {
  verdict
  confidence
  headline
  recommended_action
  evidence_trail[]
  context_insights
}
Response fields.
04

Errors

401 bad key, 402 or 429 quota, 400 validation with a message.

Carmen API

Errors

401 bad key
402 or 429 quota
400 validation with a message
Errors.

Preview