Saltar al contenido principal

API Overview

AICA exposes a RESTful JSON API for managing call records, analyses, projects, alerts, users, and billing.

Base URL​

https://api.aica.grow2.ai/api/v1

Replace with your custom domain if you have one configured.

General Conventions​

  • All endpoints require authentication unless noted otherwise (the /health endpoint is public).
  • Rate limiting is enforced at 200 requests per minute per client.
  • Request and response bodies use Content-Type: application/json.
  • Every response includes a unique request ID in the X-Request-Id header for debugging and support purposes.

Response Format​

Success​

{
  "data": { ... },
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 142
  }
}

The meta object is included for paginated list endpoints. Single-resource responses omit meta or include only non-pagination metadata.

Error​

{
  "error": {
    "message": "Record not found",
    "code": "NOT_FOUND"
  }
}

Standard HTTP status codes are used: 400 for validation errors, 401 for authentication failures, 403 for authorization failures, 404 for missing resources, 429 for rate limiting, and 500 for internal errors.

API Groups​

GroupDescription
RecordsCreate, list, upload, and manage call records and transcripts
ProjectsManage projects and their analysis settings
AnalysesAccess analysis results, annotations, and QA reviews
AlertsConfigure alert rules and view triggered incidents
UsersManage organization users and invitations
BillingView usage, credits, and configure budget limits
SearchFull-text search across records, transcripts, and analyses

Pagination​

List endpoints accept page and pageSize query parameters:

GET /api/v1/records?page=2&pageSize=50
  • page defaults to 1.
  • pageSize defaults to 20, maximum 100.

Filtering and Sorting​

Most list endpoints support filtering via query parameters specific to the resource. Common parameters include:

  • projectId — filter by project
  • status — filter by processing status
  • from / to — date range (ISO 8601)
  • sort — field to sort by (e.g., createdAt, qualityScore)
  • order — asc or desc

Refer to Endpoints for resource-specific filters.

Next Steps​