CEcekura
user

Get a project

Changed on

Retrieve a single project by ID: its settings, member list, and provider credentials. A project is the workspace scoping an organization's agents, evaluators, metrics, and results.

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

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/user/v1/projects/{id}/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring required

Response

idinteger
namestring required

Name of the project Example: "Default Project"

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.

reconcile_transcripts_with_cekuraboolean

When true, observability calls that arrive with both a recording and a provider transcript are transcribed by Cekura, and for dual-channel audio the Cekura transcript is published before metrics run (provider tool and system events are kept). Mono audio and transcription failures keep the provider transcript. Billed per minute of audio at the reconciliation rate whenever a Cekura transcript is published. The create-CallLog API field reconcile_with_cekura_transcript overrides this per request. Defaults to false.

should_show_powered_byboolean

Should show powered by Example: true or false

deep_research_enabledboolean

Enable Deep Research for this project. Customers own this from project settings: turning it on surfaces the Deep Research section and opts the project into the weekly audit cron and the on-demand Generate button. The global DEEP_RESEARCH_ENABLED SettingValue remains a kill switch above it. 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

no_calls_notify_time_periodunknown
notify_daily_report_webhookboolean

Notify daily report webhook Example: true or false

notify_pre_run_webhookboolean

Send a webhook at the start of a run (before calls dispatch) to configure the external test sandbox Example: true or false

daily_report_dashboard_idsinteger[]

Dashboard IDs to include as visual snapshots in the daily report Example: [1, 2, 3]

notify_result_webhook_failedboolean

Notify result webhook failed Example: true or false

notify_result_webhook_successboolean

Notify result webhook success Example: true or false

notify_result_webhook_errorboolean

Notify result webhook for error runs (runs with error_message) Example: true or false

notify_cronjob_webhook_failedboolean

Notify cronjob webhook failed Example: true or false

notify_cronjob_webhook_successboolean

Notify cronjob webhook success Example: true or false

notify_cronjob_webhook_errorboolean

Notify cronjob webhook for error runs (runs with error_message) Example: true or false

notify_call_log_webhook_failedboolean

Notify call log webhook failed Example: true or false

notify_call_log_webhook_successboolean

Notify call log webhook success Example: true or false

call_log_webhook_redact_fieldsstring[]

PII fields to redact from outgoing call log webhook payloads (including metadata and dynamic variables). Stored call logs are not changed. Empty list disables it. voice_recording_url is sent as null unless the agent's own redact_fields include every field listed here (recordings ingested before the agent enabled redaction are not redacted), and provider recording/log links in metadata are removed. Forwarded raw provider webhooks (forward_vapi_webhook, forward_retell_webhook) are not redacted. Example: ["ssn", "dob", "email_address"]

skip_call_log_webhook_no_contentboolean

Skip call log webhooks for calls with no conversation content: no spoken transcript, or a busy / no-answer ended reason Example: true or false

notify_frequent_calls_for_numberboolean
frequent_calls_thresholdinteger
frequent_calls_time_periodinteger
frequent_calls_cooldowninteger
forward_vapi_webhookboolean

Forward vapi webhook Example: true or false

forward_retell_webhookboolean

Forward retell webhook Example: true or false

is_send_emails_enabledboolean

Is send emails enabled Example: true or false

rubric_configunknown
timezonestring

Project Timezone

vapi_api_keystring

VAPI Private API Key. Used for all VAPI operations (calls, chat, and testing). Example: "vapi_api_key_123"

vapi_api_key_configuredstring
vapi_public_key_configuredstring
retell_api_keystring

Retell API key Example: "retell_api_key_123"

retell_api_key_configuredstring
syntflow_api_keystring

Syntflow API key Example: "syntflow_api_key_123"

syntflow_api_key_configuredstring
elevenlabs_api_keystring

ElevenLabs API key Example: "elevenlabs_api_key_123"

elevenlabs_api_key_configuredstring
bland_api_keystring

Bland API key Example: "bland_api_key_123"

bland_api_key_configuredstring
livekit_api_keystring

LiveKit API key Example: "livekit_api_key_123"

livekit_api_key_configuredstring
pipecat_api_keystring

Pipecat/Daily.co API key Example: "pipecat_api_key_123"

pipecat_api_key_configuredstring
is_deletedboolean
created_atstring date-time
updated_atstring date-time

Changes

  • a6fb6a739212Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • info

      api operation id projects-retrieve removed and replaced with projects-retrieve_2

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      the endpoint scheme security supabase_session was added to the API

    • info

      for the path request parameter id, the type was generalized from integer to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional write-only property bland_api_key to the response with the status

    • info

      added the optional write-only property elevenlabs_api_key to the response with the status

    • info

      added the optional write-only property livekit_api_key to the response with the status

    • info

      added the optional write-only property pipecat_api_key to the response with the status

    • info

      added the optional write-only property retell_api_key to the response with the status

    • info

      added the optional write-only property syntflow_api_key to the response with the status

    • info

      added the optional write-only property vapi_api_key to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property ///// to the response with the status