KilevelDocs
Platform

API reference

Call & Chat History

8 endpoints. Add your API key in the authentication panel to send test requests from this page.

List generated calls

GET/api/external/v1/applications/{appId}/generated-calls

Returns a paginated list of generated-call rows. This only includes rows that belong to Generated Calls system jobs (GENERATED_CALLS*). If appId is provided, it only returns rows for that application.

Parameters

  • appIdstring (uuid)pathRequired

    Optional unique UUID of the application

  • pageinteger (int32)query

    Page number (0-indexed)

  • sizeinteger (int32)query

    Items per page (max 200)

  • startDatestring (date-time)query

    Filter by row creation start date (ISO 8601)

  • endDatestring (date-time)query

    Filter by row creation end date (ISO 8601)

  • plannedStartDatestring (date-time)query

    Filter by planned-call start date (ISO 8601)

  • plannedEndDatestring (date-time)query

    Filter by planned-call end date (ISO 8601)

  • sortBystringquery

    Field to sort by (createdAt, plannedCallDateTime, status, duration, etc.)

  • sortDirstringquery

    Sort direction (asc, desc)

  • statusarray of stringquery

    Optional list of row statuses to include

  • searchstringquery

    Simple search across destination and caller numbers

  • approvedbooleanquery

    Filter by approval state

  • approvalSourcestringquery

    Filter by approval source (AUTO, USER)

  • excludeFinishedbooleanquery

    Exclude finished generated calls (DONE, DONE_WD, DONE_WC, ERROR)

  • flattenOutputsbooleanquery

    Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

  • 200Paginated generated calls
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Call history

GET/api/external/v1/call-history

Searches and retrieves call history with advanced filtering, sorting, and pagination. This endpoint allows querying across all jobs and standalone outbound/inbound calls.

Parameters

  • pageinteger (int32)query

    Page number (0-indexed)

  • sizeinteger (int32)query

    Items per page (max 200)

  • jobIdstring (uuid)query

    Filter by specific job UUID

  • startDatestring (date-time)query

    Filter by start date (ISO 8601)

  • endDatestring (date-time)query

    Filter by end date (ISO 8601)

  • sortBystringquery

    Field to sort by (createdAt, status, duration, etc.)

  • sortDirstringquery

    Sort direction (asc, desc)

  • inputKeystringquery

    Filter by a key in the input rowData

  • inputValuestringquery

    Value to match in input rowData

  • outputKeystringquery

    Filter by a key in the output results

  • outputValuestringquery

    Value to match in output results

  • flowIdstring (uuid)query

    Filter by flow (internal UUID)

  • agentIdstringquery

    Filter by agent (API ID or UUID)

  • directionstringquery

    Filter by call direction (INBOUND, OUTBOUND)

  • flattenOutputsbooleanquery

    Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

  • 200Paginated call history
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

List all call rows

GET/api/external/v1/call-jobs/rows

Returns a paginated list of all call rows across all jobs owned by the user associated with the API key. This is a convenient alias for retrieving the full call history.

Parameters

  • pageinteger (int32)query

    Page number (0-indexed)

  • sizeinteger (int32)query

    Items per page (max 200)

Responses

  • 200Paginated call history
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Get call row

GET/api/external/v1/call-rows/{rowId}

Retrieves the details of a specific call row by its unique UUID. Includes status, duration, recording URL, transcription, and outcome details.

Parameters

  • rowIdstring (uuid)pathRequired

    The unique UUID of the call row

  • flattenOutputsbooleanquery

    Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

  • 200Call row details
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Chat history

GET/api/external/v1/chat-history

Searches and retrieves chat session history with advanced filtering, sorting, and pagination. This endpoint allows querying across all widgets owned by the user associated with the API key.

Parameters

  • pageinteger (int32)query

    Page number (0-indexed)

  • sizeinteger (int32)query

    Items per page (max 200)

  • widgetIdstring (uuid)query

    Filter by specific widget UUID

  • startDatestring (date-time)query

    Filter by start date (ISO 8601)

  • endDatestring (date-time)query

    Filter by end date (ISO 8601)

  • sortBystringquery

    Field to sort by (createdAt, status, durationSeconds, etc.)

  • sortDirstringquery

    Sort direction (asc, desc)

  • contactIdentifierstringquery

    Filter by contact identifier

  • statusstringquery

    Filter by session status (STARTED, ENDED, etc.)

  • contactEmailstringquery

    Filter by contact email

  • contactPhonestringquery

    Filter by contact phone

  • flattenOutputsbooleanquery

    Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

  • 200Paginated chat history
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Get chat session

GET/api/external/v1/chat-sessions/{sessionId}

Retrieves status and metadata for a specific chat session. Includes status, duration, AI summary, and metadata.

Parameters

  • sessionIdstring (uuid)pathRequired

    The unique UUID of the chat session

  • flattenOutputsbooleanquery

    Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

  • 200Chat session details
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

List all chat session messages

GET/api/external/v1/chat-sessions/{sessionId}/messages

Returns chronological list of all messages (visitor, AI, agent, system, metadata) in a session. Includes roles (USER, ASSISTANT, etc.) and message content.

Parameters

  • sessionIdstring (uuid)pathRequired

    The unique UUID of the chat session

Responses

  • 200List of messages
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

List generated calls

GET/api/external/v1/generated-calls

Returns a paginated list of generated-call rows. This only includes rows that belong to Generated Calls system jobs (GENERATED_CALLS*). If appId is provided, it only returns rows for that application.

Parameters

  • pageinteger (int32)query

    Page number (0-indexed)

  • sizeinteger (int32)query

    Items per page (max 200)

  • startDatestring (date-time)query

    Filter by row creation start date (ISO 8601)

  • endDatestring (date-time)query

    Filter by row creation end date (ISO 8601)

  • plannedStartDatestring (date-time)query

    Filter by planned-call start date (ISO 8601)

  • plannedEndDatestring (date-time)query

    Filter by planned-call end date (ISO 8601)

  • sortBystringquery

    Field to sort by (createdAt, plannedCallDateTime, status, duration, etc.)

  • sortDirstringquery

    Sort direction (asc, desc)

  • statusarray of stringquery

    Optional list of row statuses to include

  • searchstringquery

    Simple search across destination and caller numbers

  • approvedbooleanquery

    Filter by approval state

  • approvalSourcestringquery

    Filter by approval source (AUTO, USER)

  • excludeFinishedbooleanquery

    Exclude finished generated calls (DONE, DONE_WD, DONE_WC, ERROR)

  • flattenOutputsbooleanquery

    Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

  • 200Paginated generated calls
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found