> ## Documentation Index > Fetch the complete documentation index at: https://docs.cekura.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update project > Update a project ## OpenAPI ````yaml patch /user/v1/projects/{id}/ openapi: 3.1.0 info: title: Cekura API version: v1 description: >- Complete API documentation for the Cekura platform. This API provides endpoints for testing, observing, and evaluating AI voice agents — including managing agents, running evaluators, defining metrics, and analyzing call quality. servers: - url: https://api.cekura.ai security: [] paths: /user/v1/projects/{id}/: patch: tags: - user description: Update a project operationId: projects-partial-update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this project. required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProject' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedProject' multipart/form-data: schema: $ref: '#/components/schemas/PatchedProject' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' security: - api_key: [] components: schemas: PatchedProject: type: object properties: id: type: integer readOnly: true name: type: string description: | Name of the project Example: `"Default Project"` members: type: array items: $ref: '#/components/schemas/MembershipInline' readOnly: true organization: allOf: - $ref: '#/components/schemas/OrganizationInline' readOnly: true outbound_timeout: type: integer description: | Outbound timeout in seconds Example: `300` max_call_duration: type: integer description: | Max call duration in seconds Example: `300` min_call_duration: type: integer description: | Min call duration in seconds Example: `30` sample_rate: type: number format: double description: | Metric sampling rate (0.0 to 1.0). Default is 1.0 (100% of calls). Example: `0.5` (50%), `0.1` (10%), `0.001` (0.1%) max_messages_chat_runs_limit: type: integer description: | Max messages chat runs limit Example: `100` webhook_url: type: string format: uri description: | Webhook URL Example: `"https://yourdomain.com/webhook"` webhook_secret: type: string writeOnly: true description: > Webhook secret. Sent in `X-CEKURA-SECRET` header when invoking `webhook_url`. Write-only — never returned in API responses. Use `webhook_secret_configured` to check whether one is set. Example: `"your-webhook-secret"` webhook_secret_configured: type: string readOnly: true evaluate_relevant_metrics_enabled: type: boolean description: | Evaluate relevant metrics enabled Example: `true` or `false` end_call_enabled: type: boolean description: | End call enabled Example: `true` or `false` generate_scenario_auto_assign_numbers_enabled: type: boolean description: | Generate scenario auto assign numbers enabled Example: `true` or `false` enable_client_side_testing: type: boolean description: | Enable client side testing Example: `true` or `false` use_provider_transcript: type: boolean description: >- When true, evaluations use the provider transcript instead of Cekura transcript with provider side tool calls. Defaults to false. should_show_powered_by: type: boolean description: | Should show powered by Example: `true` or `false` notify_results_completion: type: boolean description: | Notify on result completion Example: `true` or `false` notify_daily_report: type: boolean description: | Notify daily report Example: `true` or `false` notify_daily_report_no_calls: type: boolean description: | Notify daily report even if there are no calls Example: `true` or `false` daily_report_ai_summary_enabled: type: boolean description: > Replace the default daily report data dump with an AI-narrated Top Issues section in Slack and email. Off by default. When on, Slack also exposes a "Show more" button that opens a modal with the legacy detail sections. Example: `true` or `false` notify_cron_failure: type: boolean description: | Notify cron failure Example: `true` or `false` notify_cron_success: type: boolean description: | Notify cron success Example: `true` or `false` notify_no_calls: type: boolean description: | Notify no calls Example: `true` or `false` no_calls_notify_time_period: description: > Configuration for no calls notification time periods, timeframes, exception numbers, and agents to exclude Example: ```json { "time_zone": "America/New_York", "time_periods": [ { "start_time": "09:00", "end_time": "17:00", "time_frame": 30 }, { "start_time": "18:00", "end_time": "23:59", "time_frame": 60 } ], "exception_numbers": ["+15551234567", "+14155552671"], "agents": [1, 10, 90] } ``` Note: - Calls with customer_number in exception_numbers list will be ignored when checking for no calls alert. - If agents list is provided and not empty, those specific agents will be excluded from monitoring. All other agents in the project will be monitored. If omitted or empty, all agents in the project will be monitored. notify_daily_report_webhook: type: boolean description: | Notify daily report webhook Example: `true` or `false` daily_report_dashboard_ids: type: array items: type: integer description: | Dashboard IDs to include as visual snapshots in the daily report Example: `[1, 2, 3]` notify_result_webhook_failed: type: boolean description: | Notify result webhook failed Example: `true` or `false` notify_result_webhook_success: type: boolean description: | Notify result webhook success Example: `true` or `false` notify_result_webhook_error: type: boolean description: | Notify result webhook for error runs (runs with error_message) Example: `true` or `false` notify_cronjob_webhook_failed: type: boolean description: | Notify cronjob webhook failed Example: `true` or `false` notify_cronjob_webhook_success: type: boolean description: | Notify cronjob webhook success Example: `true` or `false` notify_cronjob_webhook_error: type: boolean description: | Notify cronjob webhook for error runs (runs with error_message) Example: `true` or `false` notify_call_log_webhook_failed: type: boolean description: | Notify call log webhook failed Example: `true` or `false` notify_call_log_webhook_success: type: boolean description: | Notify call log webhook success Example: `true` or `false` notify_frequent_calls_for_number: type: boolean frequent_calls_threshold: type: integer maximum: 2147483647 minimum: -2147483648 frequent_calls_time_period: type: integer maximum: 2147483647 minimum: -2147483648 frequent_calls_cooldown: type: integer maximum: 2147483647 minimum: -2147483648 forward_vapi_webhook: type: boolean description: | Forward vapi webhook Example: `true` or `false` forward_retell_webhook: type: boolean description: | Forward retell webhook Example: `true` or `false` is_send_emails_enabled: type: boolean description: | Is send emails enabled Example: `true` or `false` rubric_config: description: > Project-level scoring rubric for evaluating call success. Each call log produced under this project is run against the rubric and gets a single pass/fail outcome based on its metric results. IMPORTANT (read before writing): - NEVER blindly overwrite this field. Always first GET the project, read the existing `rubric_config`, then merge in only the rule(s) you intend to add/update, and PATCH the full merged value. Sending a partial value will silently delete every rule you did not include. Structure: - `evaluation_logic`: MUST be `"and"`. All rules have to pass for a call to be marked successful. (Other values are not supported by the product currently.) - `rules`: List of rules. Use one rule per (metric, condition) — keep each rule simple, with a single condition inside. Each rule shape: ```json { "metric_id": , "conditions": { "operator": "and", "conditions": [ {"field": , "op": , "value": } ] } } ``` What `field`, `op`, and `value` to use depends on the metric type. The three supported cases: 1. Numeric / score metrics (qualitative scores, numeric metrics, workflow adherence with a score, etc.): - `field`: `"score"` - `op`: one of `"gt"`, `"gte"`, `"lt"`, `"lte"`, `"eq"` - `value`: a number (qualitative scores are on a 0–5 scale) - Example (score must be at least 4): `{"field": "score", "op": "gte", "value": 4}` 2. Boolean / binary metrics (eval_type `binary_qualitative`, `binary_workflow_adherence`, or `evaluate_expected_outcome`): - Boolean outcomes are stored as a score: True → `5`, False → `0`. - `field`: `"score"` - `op`: `"eq"` or `"neq"` - `value`: `5` for True, `0` for False - Example (must be True): `{"field": "score", "op": "eq", "value": 5}` - Example (must be False): `{"field": "score", "op": "eq", "value": 0}` 3. Enum metrics (eval_type `enum`, or `observability_topics` / `observability_dropoff`): - `field`: `"enum"` - `op`: `"eq"`, `"neq"`, or `"in"` - `value`: a single string for `eq`/`neq`, or a list of strings for `in`. Must match one of the metric's defined `enum_values`. - Example: `{"field": "enum", "op": "eq", "value": "resolved"}` - Example (any of): `{"field": "enum", "op": "in", "value": ["resolved", "partially_resolved"]}` Full example: ```json { "evaluation_logic": "and", "rules": [ { "metric_id": 115164, "conditions": { "operator": "and", "conditions": [ {"op": "eq", "field": "score", "value": 5} ] } }, { "metric_id": 5512, "conditions": { "operator": "and", "conditions": [ {"op": "gte", "field": "score", "value": 4} ] } }, { "metric_id": 8821, "conditions": { "operator": "and", "conditions": [ {"op": "in", "field": "enum", "value": ["resolved", "partially_resolved"]} ] } } ] } ``` Notes: - `metric_id` must reference a metric belonging to this project (project-scoped or agent-scoped under this project); unknown ids are rejected. - Rules whose metric did not produce a value on a given call are skipped (neither pass nor fail) and do not affect the outcome. - Pass an empty object `{}` to clear the rubric. timezone: type: string description: | Project Timezone vapi_api_key: type: string writeOnly: true description: > VAPI Private API Key. Used for all VAPI operations (calls, chat, and testing). Example: `"vapi_api_key_123"` vapi_api_key_configured: type: string readOnly: true vapi_public_key_configured: type: string readOnly: true retell_api_key: type: string writeOnly: true description: | Retell API key Example: `"retell_api_key_123"` retell_api_key_configured: type: string readOnly: true syntflow_api_key: type: string writeOnly: true description: | Syntflow API key Example: `"syntflow_api_key_123"` syntflow_api_key_configured: type: string readOnly: true elevenlabs_api_key: type: string writeOnly: true description: | ElevenLabs API key Example: `"elevenlabs_api_key_123"` elevenlabs_api_key_configured: type: string readOnly: true livekit_api_key: type: string writeOnly: true description: | LiveKit API key Example: `"livekit_api_key_123"` livekit_api_key_configured: type: string readOnly: true pipecat_api_key: type: string writeOnly: true description: | Pipecat/Daily.co API key Example: `"pipecat_api_key_123"` pipecat_api_key_configured: type: string readOnly: true is_deleted: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true Project: type: object properties: id: type: integer readOnly: true name: type: string description: | Name of the project Example: `"Default Project"` members: type: array items: $ref: '#/components/schemas/MembershipInline' readOnly: true organization: allOf: - $ref: '#/components/schemas/OrganizationInline' readOnly: true outbound_timeout: type: integer description: | Outbound timeout in seconds Example: `300` max_call_duration: type: integer description: | Max call duration in seconds Example: `300` min_call_duration: type: integer description: | Min call duration in seconds Example: `30` sample_rate: type: number format: double description: | Metric sampling rate (0.0 to 1.0). Default is 1.0 (100% of calls). Example: `0.5` (50%), `0.1` (10%), `0.001` (0.1%) max_messages_chat_runs_limit: type: integer description: | Max messages chat runs limit Example: `100` webhook_url: type: string format: uri description: | Webhook URL Example: `"https://yourdomain.com/webhook"` webhook_secret: type: string writeOnly: true description: > Webhook secret. Sent in `X-CEKURA-SECRET` header when invoking `webhook_url`. Write-only — never returned in API responses. Use `webhook_secret_configured` to check whether one is set. Example: `"your-webhook-secret"` webhook_secret_configured: type: string readOnly: true evaluate_relevant_metrics_enabled: type: boolean description: | Evaluate relevant metrics enabled Example: `true` or `false` end_call_enabled: type: boolean description: | End call enabled Example: `true` or `false` generate_scenario_auto_assign_numbers_enabled: type: boolean description: | Generate scenario auto assign numbers enabled Example: `true` or `false` enable_client_side_testing: type: boolean description: | Enable client side testing Example: `true` or `false` use_provider_transcript: type: boolean description: >- When true, evaluations use the provider transcript instead of Cekura transcript with provider side tool calls. Defaults to false. should_show_powered_by: type: boolean description: | Should show powered by Example: `true` or `false` notify_results_completion: type: boolean description: | Notify on result completion Example: `true` or `false` notify_daily_report: type: boolean description: | Notify daily report Example: `true` or `false` notify_daily_report_no_calls: type: boolean description: | Notify daily report even if there are no calls Example: `true` or `false` daily_report_ai_summary_enabled: type: boolean description: > Replace the default daily report data dump with an AI-narrated Top Issues section in Slack and email. Off by default. When on, Slack also exposes a "Show more" button that opens a modal with the legacy detail sections. Example: `true` or `false` notify_cron_failure: type: boolean description: | Notify cron failure Example: `true` or `false` notify_cron_success: type: boolean description: | Notify cron success Example: `true` or `false` notify_no_calls: type: boolean description: | Notify no calls Example: `true` or `false` no_calls_notify_time_period: description: > Configuration for no calls notification time periods, timeframes, exception numbers, and agents to exclude Example: ```json { "time_zone": "America/New_York", "time_periods": [ { "start_time": "09:00", "end_time": "17:00", "time_frame": 30 }, { "start_time": "18:00", "end_time": "23:59", "time_frame": 60 } ], "exception_numbers": ["+15551234567", "+14155552671"], "agents": [1, 10, 90] } ``` Note: - Calls with customer_number in exception_numbers list will be ignored when checking for no calls alert. - If agents list is provided and not empty, those specific agents will be excluded from monitoring. All other agents in the project will be monitored. If omitted or empty, all agents in the project will be monitored. notify_daily_report_webhook: type: boolean description: | Notify daily report webhook Example: `true` or `false` daily_report_dashboard_ids: type: array items: type: integer description: | Dashboard IDs to include as visual snapshots in the daily report Example: `[1, 2, 3]` notify_result_webhook_failed: type: boolean description: | Notify result webhook failed Example: `true` or `false` notify_result_webhook_success: type: boolean description: | Notify result webhook success Example: `true` or `false` notify_result_webhook_error: type: boolean description: | Notify result webhook for error runs (runs with error_message) Example: `true` or `false` notify_cronjob_webhook_failed: type: boolean description: | Notify cronjob webhook failed Example: `true` or `false` notify_cronjob_webhook_success: type: boolean description: | Notify cronjob webhook success Example: `true` or `false` notify_cronjob_webhook_error: type: boolean description: | Notify cronjob webhook for error runs (runs with error_message) Example: `true` or `false` notify_call_log_webhook_failed: type: boolean description: | Notify call log webhook failed Example: `true` or `false` notify_call_log_webhook_success: type: boolean description: | Notify call log webhook success Example: `true` or `false` notify_frequent_calls_for_number: type: boolean frequent_calls_threshold: type: integer maximum: 2147483647 minimum: -2147483648 frequent_calls_time_period: type: integer maximum: 2147483647 minimum: -2147483648 frequent_calls_cooldown: type: integer maximum: 2147483647 minimum: -2147483648 forward_vapi_webhook: type: boolean description: | Forward vapi webhook Example: `true` or `false` forward_retell_webhook: type: boolean description: | Forward retell webhook Example: `true` or `false` is_send_emails_enabled: type: boolean description: | Is send emails enabled Example: `true` or `false` rubric_config: description: > Project-level scoring rubric for evaluating call success. Each call log produced under this project is run against the rubric and gets a single pass/fail outcome based on its metric results. IMPORTANT (read before writing): - NEVER blindly overwrite this field. Always first GET the project, read the existing `rubric_config`, then merge in only the rule(s) you intend to add/update, and PATCH the full merged value. Sending a partial value will silently delete every rule you did not include. Structure: - `evaluation_logic`: MUST be `"and"`. All rules have to pass for a call to be marked successful. (Other values are not supported by the product currently.) - `rules`: List of rules. Use one rule per (metric, condition) — keep each rule simple, with a single condition inside. Each rule shape: ```json { "metric_id": , "conditions": { "operator": "and", "conditions": [ {"field": , "op": , "value": } ] } } ``` What `field`, `op`, and `value` to use depends on the metric type. The three supported cases: 1. Numeric / score metrics (qualitative scores, numeric metrics, workflow adherence with a score, etc.): - `field`: `"score"` - `op`: one of `"gt"`, `"gte"`, `"lt"`, `"lte"`, `"eq"` - `value`: a number (qualitative scores are on a 0–5 scale) - Example (score must be at least 4): `{"field": "score", "op": "gte", "value": 4}` 2. Boolean / binary metrics (eval_type `binary_qualitative`, `binary_workflow_adherence`, or `evaluate_expected_outcome`): - Boolean outcomes are stored as a score: True → `5`, False → `0`. - `field`: `"score"` - `op`: `"eq"` or `"neq"` - `value`: `5` for True, `0` for False - Example (must be True): `{"field": "score", "op": "eq", "value": 5}` - Example (must be False): `{"field": "score", "op": "eq", "value": 0}` 3. Enum metrics (eval_type `enum`, or `observability_topics` / `observability_dropoff`): - `field`: `"enum"` - `op`: `"eq"`, `"neq"`, or `"in"` - `value`: a single string for `eq`/`neq`, or a list of strings for `in`. Must match one of the metric's defined `enum_values`. - Example: `{"field": "enum", "op": "eq", "value": "resolved"}` - Example (any of): `{"field": "enum", "op": "in", "value": ["resolved", "partially_resolved"]}` Full example: ```json { "evaluation_logic": "and", "rules": [ { "metric_id": 115164, "conditions": { "operator": "and", "conditions": [ {"op": "eq", "field": "score", "value": 5} ] } }, { "metric_id": 5512, "conditions": { "operator": "and", "conditions": [ {"op": "gte", "field": "score", "value": 4} ] } }, { "metric_id": 8821, "conditions": { "operator": "and", "conditions": [ {"op": "in", "field": "enum", "value": ["resolved", "partially_resolved"]} ] } } ] } ``` Notes: - `metric_id` must reference a metric belonging to this project (project-scoped or agent-scoped under this project); unknown ids are rejected. - Rules whose metric did not produce a value on a given call are skipped (neither pass nor fail) and do not affect the outcome. - Pass an empty object `{}` to clear the rubric. timezone: type: string description: | Project Timezone vapi_api_key: type: string writeOnly: true description: > VAPI Private API Key. Used for all VAPI operations (calls, chat, and testing). Example: `"vapi_api_key_123"` vapi_api_key_configured: type: string readOnly: true vapi_public_key_configured: type: string readOnly: true retell_api_key: type: string writeOnly: true description: | Retell API key Example: `"retell_api_key_123"` retell_api_key_configured: type: string readOnly: true syntflow_api_key: type: string writeOnly: true description: | Syntflow API key Example: `"syntflow_api_key_123"` syntflow_api_key_configured: type: string readOnly: true elevenlabs_api_key: type: string writeOnly: true description: | ElevenLabs API key Example: `"elevenlabs_api_key_123"` elevenlabs_api_key_configured: type: string readOnly: true livekit_api_key: type: string writeOnly: true description: | LiveKit API key Example: `"livekit_api_key_123"` livekit_api_key_configured: type: string readOnly: true pipecat_api_key: type: string writeOnly: true description: | Pipecat/Daily.co API key Example: `"pipecat_api_key_123"` pipecat_api_key_configured: type: string readOnly: true is_deleted: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - name MembershipInline: type: object properties: id: type: integer readOnly: true user: allOf: - $ref: '#/components/schemas/UserInline' readOnly: true role: enum: - admin - member - view_only - labs - labs_view_only type: string description: |- * `admin` - Admin * `member` - Member * `view_only` - View Only * `labs` - Labs * `labs_view_only` - Labs View Only x-spec-enum-id: f1010be885c63dff is_email_notify_enabled: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true OrganizationInline: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 members: type: array items: $ref: '#/components/schemas/MembershipInline' readOnly: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - name UserInline: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 email: type: string format: email maxLength: 254 required: - email - name securitySchemes: api_key: type: apiKey name: X-CEKURA-API-KEY in: header description: >- API Key Authentication. It should be included in the header of each request. ````