API Overview

Overview

The Embedded API provides endpoints to integrate Querio's agentic data analysis directly into your apps. There are two versions available:

• v2 (recommended) — Conversations with multi-turn follow-ups and tagging
• v1 — Standalone runs (one question → one answer)

Authentication differs between versions:

• v2 uses Bearer token authentication
• v1 uses Basic Authentication with client credentials

Both versions support production and testing environments.

Quick Start

1. Get your credentials from the Querio team
2. Make your first request (v2):

curl -X POST https://app.querio.ai/api/v2/embed/{customer_slug}/conversations \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "How many shipments happened in the last 30 days",
    "datasourceId": "your_dataset_id",
    "scope": {
      "customer_id": "your_customer_id"
    },
    "environment": "production",
    "tags": {
      "user_id": "your_user_id"
    }
  }'

API v2 — Conversations

v2 introduces conversations as the top-level entity. A conversation stores the full message history, and each user–assistant pair is a turn. This enables multi-turn follow-ups within a single conversation, plus tagging for filtering and organization.

• POST /v2/embed/{customer_slug}/conversations - Start a new conversation
• POST /v2/embed/{customer_slug}/conversations/{conversationId}/turns - Add a follow-up turn
• GET /v2/embed/{customer_slug}/conversations - List conversations with filtering and pagination
• GET /v2/embed/{customer_slug}/conversations/{conversationId} - Get a conversation and its full message history

API v1 — Runs

v1 provides standalone runs where each run is one question → one answer.

• POST /v1/embed/{customer_slug}/runs - Start a new AI-powered analysis run
• GET /v1/embed/{customer_slug}/runs - List all runs with filtering and pagination
• GET /v1/embed/{customer_slug}/runs/{runId} - Get status and results of a specific run

Each endpoint page includes interactive examples, detailed request/response schemas, and the ability to test the API directly.

Authentication

v2 — Bearer Token

All v2 endpoints require a Bearer token in the Authorization header:

Authorization: Bearer <your_token>

You will receive your API token during onboarding. No client ID or client secret is involved in the auth header.

v1 — Basic Authentication

All v1 endpoints require Basic Authentication using your client credentials:

• Username: Your client_id (provided during onboarding)
• Password: Your client_secret (shared once, permanent)

Authorization: Basic <base64(client_id:client_secret)>

Example: If your client_id is "myapp_123" and client_secret is "secret_abc", encode "myapp_123:secret_abc" in base64.

Additional Resources

Run in Postman

Import the collection directly into your Postman workspace with one click:

• OpenAPI Spec (v2): openapi-v2.yml - For other API clients (Insomnia, etc.)
• OpenAPI Spec (v1): openapi.yml