Skip to main content

Getting Started

The fastest way to try Covia is against a hosted venue — no install required. Every venue exposes the same REST API and SDK surface, so anything you do here works the same on a venue you run yourself.

There are public example venues you can use right now:

VenueCloudBuild
venue-1.covia.aiGoogle CloudStable — latest release
venue-2.covia.aiGoogle CloudStable — latest release
venue-3.covia.aiAWSDevelopment — latest development build
venue-4.covia.aiAzureDevelopment — latest development build
venue-test.covia.aiGoogle CloudScratch venue for experiments — data may be cleared at any time

These docs track the development build, so the examples below use venue-3 — they may occasionally be ahead of what the stable venues offer. Each venue's DID and stats are reported by GET /api/v1/status.

Prefer a UI? The Covia App lets you connect to venues and run operations interactively.

1. Call a live venue (no install)​

List the operations a venue offers, then invoke one and wait for the result. v/ops/schema/infer derives a JSON Schema from an example value:

curl https://venue-3.covia.ai/api/v1/operations

curl -X POST https://venue-3.covia.ai/api/v1/invoke \
  -H "Content-Type: application/json" \
  -d '{
        "operation": "v/ops/schema/infer",
        "input": { "value": { "name": "Ada", "age": 36 } },
        "wait": true
      }'

The venue returns a job record whose output carries the result.

2. From your code​

TypeScript​

npm install @covia/covia-sdk
import { Grid } from "@covia/covia-sdk";

const venue = await Grid.connect("https://venue-3.covia.ai");
const result = await venue.operations.run("v/ops/schema/infer", {
  value: { name: "Ada", age: 36 },
});
console.log(result); // { schema: { type: "object", ... } }
venue.close();

Python​

pip install covia
from covia import Grid

venue = Grid.connect("https://venue-3.covia.ai")
result = venue.run("v/ops/schema/infer", {"value": {"name": "Ada", "age": 36}})
print(result)  # {'schema': {'type': 'object', ...}}

A Java SDK (ai.covia:covia-core, currently built from source) is also available — see the SDK reference for the full surface in every language.

3. Run your own venue​

To control local resources, install custom adapters, or hold your own data, run a venue yourself — it's a single self-contained server:

docker run -p 8080:8080 ghcr.io/covia-ai/covia:latest

Point the examples above at http://localhost:8080. See the Operator Guide for configuration, persistence, and authentication.

What's next​