Skip to content
yves
API

Direct API access to feedback,
analytics, and event streams.

A documented, versioned REST API with scoped authentication tokens and signed webhooks. Analytical responses include underlying formulas, sample counts, and statistical intervals, ensuring consistent reporting across enterprise systems.

v1

API Stability

Backwards compatibility maintained with 12-month deprecation notices.

6

Webhook event types

HMAC-SHA256 signatures with timestamped replay protection.

100%

Metadata completeness

Formulas, sample sizes, and confidence intervals included in payloads.

Bulk

Data export endpoints

Full historical exports in JSON, CSV, and Parquet on all tiers.

Core endpoints

Primary REST resources

  • GET/v1/submissions

    Paginated access to feedback records with filtering by category, sentiment score, urgency level, integrity verdict, language, and date range.

  • GET/v1/submissions/{id}

    Fetch a single submission record including verbatim original text, normalized translation, enrichment metadata, and integrity verification signals.

  • GET/v1/search/meaning

    Cross-lingual semantic concept search across dense vector embeddings, returning relevance similarity scores.

  • GET/v1/analytics/{metric}

    Retrieve registered analytical metrics with underlying formula definitions, sample sizes, population totals, and confidence intervals.

  • GET/v1/integrity/clusters

    List identified coordinated campaign clusters with constituent submission IDs, triggering heuristics, and confidence scores.

  • POST/v1/actions

    Create a tracked operational remediation task linked to a submission ID, with designated owner and target completion date.

  • PATCH/v1/actions/{id}

    Update action status, attach resolution notes, and trigger post-resolution recurrence monitoring.

  • GET/v1/exports/corpus

    Initiate asynchronous bulk data exports of submissions, translations, enrichments, and system audit logs.

Semantic search

Cross-language concept query

api.yves.africa/v1
curl https://api.yves.africa/v1/search/meaning \
  -H "Authorization: Bearer $YVES_TOKEN" \
  -G --data-urlencode "q=staff asked me for money" \
     --data-urlencode "since=2026-08-01" \
     --data-urlencode "min_similarity=0.62"

{
  "results": [
    {
      "id": "sub_9fK2xQ",
      "language": "es",
      "original": "En recepción me pidieron algo extra para adelantar mi cita.",
      "translation": "At reception they asked me for something extra to move my appointment forward.",
      "category": "staff-conduct",
      "urgency": "critical",
      "similarity": 0.874,
      "integrity": { "verdict": "clean", "signals": [] }
    }
  ],
  "interval": { "method": "wilson", "level": 0.95 },
  "n": 3184
}

The search query in English matches a submission in Spanish based on semantic intent rather than keyword matches. This ensures critical compliance and operational reports surface regardless of the vocabulary or language used by the respondent.

Webhooks

Real-time event notifications with HMAC signatures

submission.urgent

Fired when an incoming submission exceeds the defined urgency threshold for its category.

verdict.changed

Fired when an integrity verification state transitions between clean, suspect, and quarantined.

action.created

Fired when an operational remediation task is authorized and created by assigned personnel.

action.resolved

Fired when an operational action is marked as resolved with attached documentation.

cluster.detected

Fired when anti-spam heuristics identify a coordinated burst or duplicate feedback cluster.

briefing.ready

Fired when the daily executive summary briefing is generated and ready for retrieval.

API Standards

Developer commitments and architectural standards

Version Deprecation Policy

Major API revisions run concurrently with prior versions for twelve months before deprecation.

Granular Scope Controls

Tokens support distinct read, write, and export scopes, with full revocation controls and access logging.

Complete Analytical Context

Every metric response includes mathematical formula definitions, sample counts, and confidence intervals.

Predictable Rate Limits

High-capacity tier allocations designed for production syncs, with proactive notifications prior to throttling.

Next step

Integrate Yves with your enterprise systems.

Generate scoped API tokens and configure signed webhooks in your evaluation tenant.