Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nova.dweet.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Phase 1: Job setup (once per job)

1

Generate clarification questions (optional)

POST /v1/jobs/{jobId}/question-sets with your job context.Store questionSet.id and show questionSet.questions in your UI.
2

Generate criteria

POST /v1/jobs/{jobId}/criteria/generate with your job context.If you collected answers, include questionSetId and answers.
3

Refine criteria (optional)

Use the criteria management endpoints to add, edit, remove, or archive criteria. See criteria versioning for how changes affect scoring.

Phase 2: Application scoring (per application)

1

Generate a resume URL

Produce a public HTTPS URL. See supported formats for requirements.
2

Submit a scoring request

POST /v1/jobs/{jobId}/applications/{applicationId}/scoring-jobs with the resume object and jobDescription.Store scoringJob.id and scoringJob.criteriaVersionId for webhook correlation and polling.
3

Handle webhooks

Verify the signature and process score.completed and score.failed events. See webhooks.

Polling fallback

If you miss a webhook: GET /v1/jobs/{jobId}/applications/{applicationId}/scoring-jobs/{scoringJobId}

Phase 3: Deletion handling

Build deletion calls into your customer offboarding and application deletion workflows.
1

Delete one application

Call DELETE /v1/jobs/{jobId}/applications/{applicationId} with X-Tenant-Id.Use this when an application must be removed before automatic cleanup runs.
2

Delete one tenant

Call DELETE /v1/tenants/{tenantExternalId} when a customer leaves or asks you to delete all tenant data.This endpoint scopes the request by path, so it doesn’t need X-Tenant-Id.
3

Poll for completion

Store the returned deletionRequest.id and poll GET /v1/deletion-requests/{deletionRequestId} until the request is completed or failed.Completed responses confirm the request was processed. Nova keeps internal cleanup evidence separately.
See Deletion Requests for the API flow and Data Retention for retention windows.