Quickstart

If you’re new to Avido, start by creating an account in our dashboard. Once you log in, head to the Applications section to manage your app IDs.

Each application has a unique UUID. From the Applications page, select or create a new application. Note its App ID (UUID)—we’ll need this shortly.

Head to API Keys in the Avido dashboard. Generate a new key if you don’t have one already. Keep it secure—this key grants access to your data via the Avido API.

For every API request, you’ll need two headers: Authorization: Bearer YOUR_API_KEY x-avido-app-id: YOUR_APP_UUID If either is missing or invalid, you’ll encounter a 401/403 error.

To log your first LLM event:

curl -X POST "https://api.avidoai.com/v0/ingest" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-avido-app-id: YOUR_APP_UUID" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "type": "llm",
        "event": "start",
        "runId": "run_123",
        "timestamp": "2025-01-05T12:34:56.789Z",
        "input": "Hello from the quickstart!"
      }
    ]
  }'

If everything is correct, you’ll get a 200 response with a JSON body like:

{
  "results": [
    {
      "id": "run_123",
      "success": true
    }
  ]
}

You’ve officially recorded your first event in Avido!

Avido stores this data internally. You can view it in your dashboard to track LLM usage, measure cost, or debug calls. If monitoring is disabled for your app, make sure evaluationId is present on your events to avoid filtering.

Threads let you model conversations or sessions in your app. They’re handy for chat-based flows where you want to group messages and responses under a single parent.

curl -X POST "https://api.avidoai.com/v0/threads" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-avido-app-id: YOUR_APP_UUID" \
  -H "Content-Type: application/json" \
  -d '{
    "threadId": "thread_custom_0001",
    "metadata": { "topic": "Support session" },
    "message": {
      "role": "user",
      "content": "Hello, I'd like some help with your API."
    }
  }'

On success, you’ll see a response like:

{
  "threadId": "thread_custom_0001",
  "success": true
}

Use that threadId as parentRunId for subsequent events in this conversation.

If your use case involves receiving or validating external requests, head to your Application settings. Enable webhooks and note your webhookSecret.

Every incoming request to

POST /v0/webhook

will include a signature header. Our server will compare that header with an HMAC generated using your webhookSecret. If valid, you’ll see:

{
  "valid": true
}

Otherwise, you’ll receive a 401 error and a short message (e.g. "Invalid webhook signature").