API Overview

Overview

The Embedded API provides endpoints to:

• Start AI agent runs - Start a Querio-powered AI agent run
• Retrieve inidvidual runs - Get the status and detailed results of any run
• List all runs - Browse and search through all your runs

All endpoints use Basic Authentication with your client credentials and support both production and testing environments.

Quick Start

1. Get your credentials from the Querio team
2. Encode your client id and secret in base64: base64(client_id:client_secret)
3. Make your first request:

curl -X POST https://server.prod.querio.ai/v1/embed/{customer_slug}/runs \
  -H "Authorization: Basic <{your_base64_credentials}>" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "How many shipments happened in the last 30 days",
    "dataset_id": "your_dataset_id",
    "scope": {
      "customer_id": "your_customer_id"
    },
    "environment": "production"
  }'

API Endpoints

The Embedded API provides three main endpoints:

• 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

All API endpoints require Basic Authentication using your client credentials:

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

Include the Authorization header with base64-encoded credentials:

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: openapi.yml - For other API clients (Insomnia, etc.)