Profiles
Create an analysis profile
POST
/api/v1alpha1/profilesCreates profile head and immutable version 1. New runs can reference the returned profile id.
Authorization
apiKey AuthorizationBearer <token>
In: header
Header Parameters
Idempotency-Key?string
Optional key for safe retry of this POST. The key is retained for 24 hours and compared with the request payload and concrete path parameters.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1alpha1/profiles" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "answer_specs": [ { "aggregation_level": "video", "answer_key": "", "answer_type": "timeline", "coverage": "complete", "evidence": { "accepted_types": [ "clip" ], "per_field": true, "required": true }, "fields": [ { "description": "", "key": "", "label": "", "required": true, "type": "string" } ], "temporal_granularity": "semantic_segment", "temporal_scope": "windowed" } ], "description": "Reusable profile for safety reviews.", "instructions": "", "name": "Warehouse safety profile" }'{ "anonymous": false, "created_at": "2026-08-22T10:00:00.000Z", "created_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "description": "Reusable profile for safety reviews.", "id": "prof_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "latest_version": 3, "name": "Warehouse safety profile", "status": "active", "updated_at": "2026-08-22T10:00:00.000Z", "updated_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"}