v1

latestOpenAPI 3.1.02026-07-22152755.8 KB
user

Retrieve a project by ID

get/user/v1/projects/{id}/

Path parameters

idinteger required

A unique integer value identifying this project.

Response

idinteger
namestring

Name of the project Example: "Default Project"

{"stackTrail":"components:schemas:OrganizationInline","oasType":"schema","type":"unknown","description":"Referenced by this API but not published in the vendor's docs pages."}
organization_idinteger

ID of the organization to create the project under. Required when authenticating as a user (you must be an admin of that organization); omit it when using an organization-scoped API key, where the organization is inferred from the key.

outbound_timeoutinteger

Outbound timeout in seconds Example: 300

max_call_durationinteger

Max call duration in seconds Example: 300

min_call_durationinteger

Min call duration in seconds Example: 30

sample_ratenumber double

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_limitinteger

Max messages chat runs limit Example: 100

webhook_urlstring uri

Webhook URL Example: "https://yourdomain.com/webhook"

webhook_secretstring

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_configuredstring
evaluate_relevant_metrics_enabledboolean

Evaluate relevant metrics enabled Example: true or false

end_call_enabledboolean

End call enabled Example: true or false

generate_scenario_auto_assign_numbers_enabledboolean

Generate scenario auto assign numbers enabled Example: true or false

enable_client_side_testingboolean

Enable client side testing Example: true or false

use_provider_transcriptboolean

When true, evaluations use the provider transcript instead of Cekura transcript with provider side tool calls. Defaults to false.

should_show_powered_byboolean

Should show powered by Example: true or false

notify_results_completionboolean

Notify on result completion Example: true or false

notify_daily_reportboolean

Notify daily report Example: true or false

notify_daily_report_no_callsboolean

Notify daily report even if there are no calls Example: true or false

daily_report_ai_summary_enabledboolean

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_failureboolean

Notify cron failure Example: true or false

notify_cron_successboolean

Notify cron success Example: true or false

notify_no_callsboolean

Notify no calls Example: true or false

{"stackTrail":"components:schemas:Project:properties:no_calls_notify_time_period","oasType":"schema","type":"unknown","description":"\nConfiguration for no calls notification time periods, timeframes, exception numbers, and agents to exclude\nExample:\n"}