Quickstart
Run your first verification in under 5 minutes.
Prerequisites
- A Crowdee account — sign up at crowdee.ai
- An API key from Settings → Integrations
- A file to verify (image, audio, video, or document)
Step 1 — Create a Project
Projects are workspaces that hold your files and verification runs. Create one before uploading anything.
curl -X POST https://api.crowdee.ai/v2/projects \
-H "X-API-Key: crw_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "My First Project"}'Example response:
{
"id": "proj_abc123",
"name": "My First Project",
"type": "standard",
"createdAt": "2024-11-15T10:00:00Z"
}Save the id — you will use it as {projectId} in subsequent requests.
Step 2 — Upload a File
Upload the file you want to verify using a multipart POST request.
curl -X POST https://api.crowdee.ai/v2/projects/{projectId}/files \
-H "X-API-Key: crw_YOUR_API_KEY" \
-F "file=@photo.jpg"Example response:
{
"id": "file_xyz789",
"name": "photo.jpg",
"mimeType": "image/jpeg",
"enrichmentStatus": "pending",
"createdAt": "2024-11-15T10:01:00Z"
}Enrichment starts automatically after upload. The platform analyses the file's technical metadata so pipelines can operate on structured data rather than raw bytes.
Step 3 — Wait for Enrichment
Most pipelines require enrichment to complete before they can run. Poll the file endpoint until enrichmentStatus is "completed".
curl https://api.crowdee.ai/v2/projects/{projectId}/files/{fileId} \
-H "X-API-Key: crw_YOUR_API_KEY"The enrichmentStatus field transitions as follows:
pending → running → completed
↘ failedDo not start a pipeline run until enrichmentStatus is "completed". Attempting to run a pipeline on an un-enriched file will return a validation error.
Step 4 — Start a Verification Run
With the file enriched, you can now start a verification pipeline.
curl -X POST https://api.crowdee.ai/v2/projects/{projectId}/verification-runs \
-H "X-API-Key: crw_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pipeline_id": "verify-image-metadata",
"file_ids": ["{fileId}"]
}'Example response:
{
"id": "run_def456",
"pipelineId": "verify-image-metadata",
"status": "running",
"createdAt": "2024-11-15T10:02:00Z"
}Save the id as {runId} for the next step.
Step 5 — Retrieve the Verdict
Poll the verification run endpoint until status is "completed".
curl https://api.crowdee.ai/v2/projects/{projectId}/verification-runs/{runId} \
-H "X-API-Key: crw_YOUR_API_KEY"Example completed response:
{
"id": "run_def456",
"pipelineId": "verify-image-metadata",
"status": "completed",
"verdict": "authentic",
"confidence": 92,
"scorecard": {
"metadata_consistency": 95,
"compression_artifacts": 88,
"timestamp_integrity": 94
},
"explanation": "Metadata is internally consistent. No signs of re-encoding or timestamp manipulation detected.",
"createdAt": "2024-11-15T10:02:00Z",
"completedAt": "2024-11-15T10:02:18Z"
}Possible verdict values: authentic, manipulated, inconclusive, unverified.
Next Steps
How is this guide?
Introduction
What Crowdee is, how it works, and where to start.
Authentication
API keys, JWT bearer tokens, and OIDC login.