Rust API client for roark-rs

Roark Analytics API - Voice AI Analytics Platform

The Roark Analytics API provides comprehensive monitoring, evaluation, and analytics capabilities for voice AI agents. This API allows developers to seamlessly integrate with the Roark platform to track call quality, analyze agent performance, and extract insights from voice interactions.

Key Features

• Real-time Call Analysis: Upload and analyze voice call recordings with AI-powered insights
• Sentiment Analysis: Extract emotional tone, key phrases, and sentiment scores across 64+ emotions
• Agent Performance Evaluation: Create custom evaluation jobs with configurable metrics and scoring
• Platform Integrations: Native support for VAPI and Retell AI with webhook-based data ingestion
• Custom Analytics: Build custom analytics pipelines with flexible data models and properties

Authentication

All API endpoints require Bearer token authentication. Include your API token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Rate Limiting

The API implements rate limiting to ensure service stability. Rate limit headers are included in responses.

Error Handling

The API uses standard HTTP status codes and returns structured error responses with detailed error information including error types, codes, and human-readable messages.

Rust Code Generation

This OpenAPI specification has been optimized for Rust code generation with:

• Snake_case field naming conventions
• Proper nullable field handling with Option
• Comprehensive documentation for generated code
• Type-safe enum definitions
• Structured error handling

For more information, please visit https://docs.roark.ai

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 0.0.2
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named roark-rs and add the following to Cargo.toml under [dependencies]:

roark-rs = { path = "./roark-rs" }

Documentation for API Endpoints

All URIs are relative to https://api.roark.ai

CallAnalysisApi | create_call_analysis_job | POST /v1/call-analysis | Create call analysis job CallAnalysisApi | get_call_analysis_job | GET /v1/call-analysis/{job_id} | Get call analysis job CallOperationsApi | get_call_evaluation_runs | GET /v1/call/{call_id}/evaluation-run | Get call evaluation runs CallOperationsApi | get_call_sentiment_analysis | GET /v1/call/{call_id}/sentiment-run | Get call sentiment analysis EvaluationApi | create_evaluation_job | POST /v1/evaluation/job | Create evaluation job EvaluationApi | get_evaluation_job | GET /v1/evaluation/job/{job_id} | Get evaluation job EvaluationApi | get_evaluation_job_runs | GET /v1/evaluation/job/{job_id}/runs | Get evaluation job runs HealthApi | get_api_health | GET /health | Get API health status IntegrationsApi | create_retell_call | POST /v1/retell/call | Send a Retell call to Roark IntegrationsApi | create_vapi_call | POST /v1/vapi/call | Send a VAPI call to Roark

Documentation For Models

• ApiResponse

• CallAnalysisCreateRequest

• CallAnalysisJob

• CallData

• CallDirection

• CallEndedStatus

• CallParticipant

• CallStatus

• CallUploadResponse

• CreateCallAnalysisJob201Response

• CreateEvaluationJob201Response

• CreateVapiCall201Response

• ErrorResponse

• ErrorType

• EvaluationEvidence

• EvaluationJobCreateRequest

• EvaluationJobCreateRequestDataset

• EvaluationJobCreateRequestEvaluators

• EvaluationJobResponse

• EvaluationJobStatus

• EvaluationMetric

• EvaluationRun

• Evaluator

• GetApiHealth200Response

• GetCallEvaluationRuns200Response

• GetCallSentimentAnalysis200Response

• GetEvaluationJob200Response

• GetEvaluationJob200ResponseAllOfData

• GetEvaluationJobRuns200Response

• GetEvaluationJobRuns200ResponseAllOfData

• HealthResponse

• HealthStatus

• InterfaceType

• JobStatus

• MetricRole

• MetricValueType

• PaginationInfo

• ParticipantRole

• RetellCallUploadRequest

• ScoreClassification

• SentimentAnalysis

• SentimentCategory

• ToolInvocation

• ToolInvocationParametersValue

• ToolInvocationResult

• ToolParameter

• ToolParameterType

• VapiCallUploadRequest

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@roark.ai