### Avido AI Get Started

Source: https://docs.avidoai.com/api-reference

Guides for users to begin with Avido AI, including an introduction to LLMOps, evaluation, and observability, as well as information on webhooks and trace validation.

```APIDOC
Get Started Guides:

Introduction:
  Title: Welcome to Avido Docs 🚀
  Description: Avido helps financial service teams ship reliable AI experiences – without slowing down innovation.
  Keywords: overview, getting started, LLMOps, evaluation, observability
  Href: /introduction

Webhooks:
  Title: Webhooks
  Description: Trigger automated Avido tests from outside your code and validate payloads securely.
  Keywords: webhooks, testing, signature verification, LLM, traces
  Href: /webhooks

```

--------------------------------

### Avido AI TypeScript Example

Source: https://docs.avidoai.com/traces

This snippet shows how to import and use the Avido library in a TypeScript project. It includes a basic setup for making calls to an AI model, demonstrating common parameters and input formatting.

```typescript
import Avido from 'avido';

// Example usage:
// const avidoClient = new Avido({
//   apiKey: 'YOUR_API_KEY'
// });

// const response = await avidoClient.generate({
//   modelId: 'gpt-4o-2024-08-06',
//   params: {
//     temperature: 1.2
//   },
//   input: [
//     {
//       role: 'user',
//       content: 'Tell me a joke.'
//     }
//   ]
// });

// console.log(response);
```

--------------------------------

### Style Guides API: Manage Style Guides

Source: https://docs.avidoai.com/quickstart

Enables listing, creating, and retrieving individual style guides. Supports pagination and filtering for style guide lists.

```APIDOC
GET /v0/style-guides
  Description: Retrieves a paginated list of style guides with optional filtering.
  Parameters:
    (query parameters for filtering and pagination may be available)
  Returns:
    A paginated list of style guide objects.
```

```APIDOC
POST /v0/style-guides
  Description: Creates a new style guide.
  Parameters:
    (request body with style guide details)
  Returns:
    The newly created style guide object.
```

```APIDOC
GET /v0/style-guides/{id}
  Description: Retrieves detailed information about a specific style guide.
  Parameters:
    id (path parameter): The unique identifier of the style guide.
  Returns:
    A detailed style guide object.
```

--------------------------------

### Style Guides API

Source: https://docs.avidoai.com/traces

Manage style guides, including listing all style guides, creating new ones, and retrieving specific style guides by ID.

```APIDOC
GET /v0/style-guides

Description:
  Lists all style guides.

Returns:
  - An array of style guide objects.
```

```APIDOC
POST /v0/style-guides

Description:
  Creates a new style guide.

Parameters:
  (Request Body)
    - style_guide_details: Configuration for the new style guide.

Returns:
  - The newly created style guide object.
```

```APIDOC
GET /v0/style-guides/{styleGuideId}

Description:
  Retrieves a single style guide by its unique identifier.

Parameters:
  - styleGuideId: The unique ID of the style guide.

Returns:
  - The style guide object matching the provided ID.
```

--------------------------------

### Avido v0.0.3 Updates

Source: https://docs.avidoai.com/quickstart

Introduces the 'Meet Quickstart' update for Avido, focusing on enhancing the understanding of AI applications. This version includes a new Quickstart Workflow that allows users to upload existing outputs via CSV to automatically generate evaluation cases, leveraging AI for smarter case creation.

```jsx
import { Update, Heading, components } from '@avido/ui';

<Update label="v0.0.3" description="Meet Quickstart" tags={["feature", "improvement"]}>
  <components.p>
    <components.img
      src="https://mintlify.s3.amazonaws.com/avido/images/003.jpg"
      alt="v0.0.3 update"
    />
    We’re thrilled to share our first public changelog, marking a step forward in our commitment to enhancing the understanding of AI applications and helping enterprises maximize the value of AI with Avido.
  </components.p>

  <Heading level="3" id="%F0%9F%9A%80-quickstart-workflow">
    🚀 Quickstart Workflow
  </Heading>
  <components.ul>
    <li>Upload existing outputs via CSV to automatically generate evaluation cases</li>
    <li>Smart AI-power</li>
  </components.ul>
</Update>
```

--------------------------------

### Install Avido SDKs

Source: https://context7_llms

Installs the Avido SDK for Node.js (npm) and Python (pip) to integrate Avido tracing into your applications.

```bash
npm i @avidoai/sdk-node   # Node
pip install avido         # Python
```

--------------------------------

### Avido AI API Reference - Style Guides

Source: https://docs.avidoai.com/api-reference

API endpoints for managing style guides within Avido AI. This covers listing style guides, creating new style guides, and retrieving specific style guides by their ID.

```APIDOC
Endpoint: /style-guides/list-style-guides
Method: GET
Description: Lists all style guides.
Details: Parameters for filtering or pagination, and the structure of style guide objects would be detailed.
```

```APIDOC
Endpoint: /style-guides/create-a-new-style-guide
Method: POST
Description: Creates a new style guide.
Details: Request body schema for style guide creation, including style guide content, would be specified.
```

```APIDOC
Endpoint: /style-guides/get-a-single-style-guide-by-id
Method: GET
Description: Retrieves a single style guide by its ID.
Details: Path parameter for style guide ID, and the detailed structure of a style guide object would be provided.
```

--------------------------------

### Style Guides API Reference

Source: https://docs.avidoai.com/traces

Manages style guides, allowing listing, creation, and retrieval of style guide details.

```APIDOC
Style Guides API:
  list-style-guides
    Description: Retrieves a list of all style guides.
    Method: GET
    Endpoint: /style-guides
    Parameters: None
    Returns:
      - array: A list of style guide objects.

  create-a-new-style-guide
    Description: Creates a new style guide.
    Method: POST
    Endpoint: /style-guides
    Parameters:
      - body (object): Style guide details.
        - name (string): The name of the style guide.
        - description (string, optional): A description for the style guide.
        - rules (object): The rules defining the style guide.
    Returns:
      - object: The newly created style guide object.

  get-a-single-style-guide-by-id
    Description: Retrieves a specific style guide by its unique identifier.
    Method: GET
    Endpoint: /style-guides/{styleGuideId}
    Parameters:
      - styleGuideId (string): The unique ID of the style guide.
    Returns:
      - object: The requested style guide object.
```

--------------------------------

### Style Guides API Reference

Source: https://docs.avidoai.com/quickstart

Manage style guides within the Avido platform, including listing, creating, and retrieving style guides.

```APIDOC
Style Guides API:
  list-style-guides:
    description: Retrieves a list of style guides.
    method: GET
    path: /style-guides
    responses:
      '200':
        description: A list of style guides.
        content:
          application/json:
            schema:
              type: array
              items: { $ref: '#/components/schemas/StyleGuide' }

  create-a-new-style-guide:
    description: Creates a new style guide.
    method: POST
    path: /style-guides
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              name: { type: string, description: The name of the style guide. }
              # ... other style guide properties
    responses:
      '201':
        description: The created style guide.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StyleGuide'
      '400':
        description: Invalid input data.

  get-a-single-style-guide-by-id:
    description: Retrieves a specific style guide by its ID.
    method: GET
    path: /style-guides/{styleGuideId}
    parameters:
      - name: styleGuideId
        in: path
        required: true
        schema: { type: string }
    responses:
      '200':
        description: The requested style guide.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StyleGuide'
      '404':
        description: Style guide not found.
```

--------------------------------

### Avido API Reference - Style Guides

Source: https://docs.avidoai.com/traces

Manages style guides within Avido, which can be used to enforce specific formatting or content standards for LLM outputs. This includes listing, creating, and retrieving style guides.

```APIDOC
API Reference - Style Guides:
  list-style-guides:
    description: Lists all style guides for an application.
    method: GET
    path: /applications/{applicationId}/style-guides
    parameters:
      - name: applicationId
        in: path
        required: true
        schema: { type: string }
    responses:
      '200':
        description: A list of style guides.
        content:
          application/json:
            schema:
              type: array
              items: { $ref: '#/components/schemas/StyleGuide' }

  create-a-new-style-guide:
    description: Creates a new style guide within an application.
    method: POST
    path: /applications/{applicationId}/style-guides
    parameters:
      - name: applicationId
        in: path
        required: true
        schema: { type: string }
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              name: { type: string, description: The name of the style guide. }
              description: { type: string, description: A description of the style guide. }
              rules: { type: object, description: The rules defining the style guide. }
    responses:
      '201':
        description: The newly created style guide.
        content:
          application/json:
            schema: { $ref: '#/components/schemas/StyleGuide' }

  get-a-single-style-guide-by-id:
    description: Retrieves a specific style guide by its unique identifier.
    method: GET
    path: /style-guides/{styleGuideId}
    parameters:
      - name: styleGuideId
        in: path
        required: true
        schema: { type: string }
    responses:
      '200':
        description: The requested style guide.
        content:
          application/json:
            schema: { $ref: '#/components/schemas/StyleGuide' }
      '404':
        description: Style guide not found.
```

--------------------------------

### Python Avido Client Setup and Ingestion

Source: https://docs.avidoai.com/traces

This snippet shows how to initialize the Avido client by fetching an API key from environment variables and how to begin the data ingestion process. It covers necessary imports and basic client instantiation.

```python
import os
from avido import Avido

client = Avido(
    api_key=os.environ.get("AVIDO_API_KEY") # optional – defaults to env
)

ingest = client.ingest.create(
```

--------------------------------

### MDX Component Setup

Source: https://docs.avidoai.com/api-reference

JavaScript code snippet for setting up MDX components, likely for rendering markdown content within a framework.

```javascript
const {useMDXComponents: _provideComponents} = arguments[0];
function _createMdxContent(props) {
 return _jsx(_Fragment, {});
}
function MDXContent(props = {}) {
 const {wrapper: MDXLayout} = {
 ..._provideComponents(),
 ...props.components
 };
 return MDXLayout ? _jsx(MDXLayout, {
 ...props,
 children: _jsx(_createMdxContent, {
 ...props
 })
 }) : _createMdxContent(props);
}
return {
 default: MDXContent
};
```

--------------------------------

### Style Guides API

Source: https://docs.avidoai.com/quickstart

Endpoints for managing style guides, enabling users to list all style guides, create new ones, and retrieve specific style guides by their ID.

```APIDOC
Style Guides API:
  list-style-guides:
    description: Retrieves a list of all style guides.
    method: GET
    path: /style-guides
    responses:
      '200':
        description: A list of style guides.
        content:
          application/json:
            schema:
              type: array
              items: { $ref: '#/components/schemas/StyleGuide' }

  create-a-new-style-guide:
    description: Creates a new style guide.
    method: POST
    path: /style-guides
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            required: [name]
            properties:
              name: { type: string, description: The name of the style guide. }
              rules: { type: object, description: The rules defining the style guide. }
    responses:
      '201':
        description: The created style guide.
        content:
          application/json:
            schema: { $ref: '#/components/schemas/StyleGuide' }
      '400':
        description: Invalid input data.

  get-a-single-style-guide-by-id:
    description: Retrieves a specific style guide by its unique identifier.
    method: GET
    path: /style-guides/{styleGuideId}
    parameters:
      - name: styleGuideId
        in: path
        required: true
        schema: { type: string }
    responses:
      '200':
        description: The requested style guide.
        content:
          application/json:
            schema: { $ref: '#/components/schemas/StyleGuide' }
      '404':
        description: Style guide not found.
```

--------------------------------

### Style Guides API Reference

Source: https://docs.avidoai.com/quickstart

Endpoints for managing style guides, including listing all style guides, creating new ones, and fetching a specific style guide by its ID.

```APIDOC
GET /api-reference/style-guides/list-style-guides
  Description: Lists all style guides.
  Parameters: None
  Returns: A list of style guides.

POST /api-reference/style-guides/create-a-new-style-guide
  Description: Creates a new style guide.
  Parameters:
    - style_guide_data: Object containing style guide details.
  Returns: The newly created style guide object.

GET /api-reference/style-guides/get-a-single-style-guide-by-id
  Description: Retrieves a single style guide by its unique identifier.
  Parameters:
    - style_guide_id: The ID of the style guide to retrieve.
  Returns: The style guide object matching the provided ID.
```

--------------------------------

### Avido AI API Reference - Style Guides

Source: https://docs.avidoai.com/api-reference

Endpoints for managing style guides within the Avido AI platform. Supports listing, creating, and retrieving style guides by their IDs.

```APIDOC
GET /v0/style-guides

Description:
Lists all style guides.

Returns:
- An array of style guide objects.
```

```APIDOC
POST /v0/style-guides

Description:
Creates a new style guide.

Request Body:
- Requires parameters for style guide creation.

Returns:
- The newly created style guide object.
```

```APIDOC
GET /v0/style-guides/{id}

Description:
Retrieves a single style guide by its unique identifier.

Parameters:
- id: The unique identifier of the style guide.

Returns:
- The style guide object matching the provided ID.
```

--------------------------------

### AvidoAI Event Ingestion Example

Source: https://docs.avidoai.com/traces

This example demonstrates how to ingest events into the AvidoAI service using the client library. It includes creating an ingestor and sending a sample trace event with a timestamp.

```javascript
const ingest = await client.ingest.create({
  events: [
    {
      timestamp: '2025-05-15T12:34:56.123456Z',
      type: 'trace'
    }
  ]
});
```

--------------------------------

### Style Guides API

Source: https://docs.avidoai.com/traces

Endpoints for managing style guides, including listing, creation, and retrieval of individual style guides.

```APIDOC
POST /v0/style-guides
  Title: Create a new style guide
  Description: Creates a new style guide.
  Example:
    POST /v0/style-guides
    Content-Type: application/json
    {
      "name": "Brand Style Guide",
      "content": "{\"colors\": \"#000\"}"
    }
  Returns:
    Details of the newly created style guide.
```

```APIDOC
GET /v0/style-guides
  Title: List style guides
  Description: Retrieves a paginated list of style guides with optional filtering.
  Parameters:
    - name (string, optional): Filter style guides by name.
  Returns:
    A paginated list of style guides.
```

```APIDOC
GET /v0/style-guides/{id}
  Title: Get a single style guide by ID
  Description: Retrieves detailed information about a specific style guide.
  Parameters:
    - id (string, required): The unique identifier of the style guide.
  Returns:
    Detailed information about the specified style guide.
```

--------------------------------

### API Reference: Style Guides

Source: https://docs.avidoai.com/api-reference

Endpoints for managing style guides. Allows listing all style guides, creating new ones, and retrieving details for a specific style guide by its ID.

```APIDOC
GET /v0/style-guides

Description:
  Lists all style guides.

Returns:
  - array: An array of style guide objects.

POST /v0/style-guides

Description:
  Creates a new style guide.
  Parameters:
    (Request Body)
      - name: string (required)
      - rules: object (required)
  Returns:
    - object: The newly created style guide object.

GET /v0/style-guides/{styleGuideId}

Description:
  Retrieves a single style guide by its ID.
  Parameters:
    - styleGuideId: string (path parameter, required)
  Returns:
    - object: The style guide object.
```

--------------------------------

### Style Guides Management

Source: https://docs.avidoai.com/api-reference

API operations for managing style guides. Includes listing all style guides, creating new ones, and retrieving specific style guides by their ID.

```APIDOC
GET /api-reference/style-guides/list-style-guides
Description: List style guides

POST /api-reference/style-guides/create-a-new-style-guide
Description: Create a new style guide

GET /api-reference/style-guides/get-a-single-style-guide-by-id
Description: Get a single style guide by ID
```

--------------------------------

### Style Guides API

Source: https://docs.avidoai.com/api-reference

Endpoints for managing style guides, including listing, creating, and retrieving by ID.

```APIDOC
GET /v0/style-guides
  Description: Retrieves a paginated list of style guides with optional filtering.
  Parameters:
    (query) filter: Optional filtering criteria for style guides.
  Returns:
    A paginated list of style guide objects.
```

```APIDOC
POST /v0/style-guides
  Description: Creates a new style guide.
  Request Body:
    (object) styleGuideData: Data for the new style guide.
  Returns:
    The newly created style guide object.
```

```APIDOC
GET /v0/style-guides/{id}
  Description: Retrieves detailed information about a specific style guide.
  Parameters:
    (path) id: The unique identifier of the style guide.
  Returns:
    A detailed style guide object.
```

--------------------------------

### Style Guides API Reference

Source: https://docs.avidoai.com/quickstart

Manage style guides, which can define standards or best practices for LLM outputs or interactions.

```APIDOC
List Style Guides:
  Endpoint: GET /style-guides
  Description: Retrieves a list of all style guides.
  Parameters:
    - limit (optional, integer): Maximum number of style guides to return.
    - offset (optional, integer): Number of style guides to skip.
  Response:
    - 200 OK: Returns a list of style guide objects.

Create a New Style Guide:
  Endpoint: POST /style-guides
  Description: Creates a new style guide.
  Request Body:
    - name (string, required): Name of the style guide.
    - rules (array of objects, required): The rules defining the style guide.
  Response:
    - 201 Created: Returns the newly created style guide object.

Get a Single Style Guide by ID:
  Endpoint: GET /style-guides/{styleGuideId}
  Description: Retrieves details for a specific style guide.
  Parameters:
    - styleGuideId (string, required): The unique identifier of the style guide.
  Response:
    - 200 OK: Returns the style guide object.
    - 404 Not Found: If the style guide ID is not found.
```

--------------------------------

### AvidoAI Style Guides API

Source: https://context7_llms

Manage style guides within the AvidoAI platform. Supports creating new style guides, retrieving them by ID, and listing all available style guides.

```APIDOC
POST /v0/style-guides
Creates a new style guide.

GET /v0/style-guides/{id}
Retrieves detailed information about a specific style guide.

GET /v0/style-guides
Retrieves a paginated list of style guides with optional filtering.
```

--------------------------------

### cURL Example for Ingesting Events

Source: https://docs.avidoai.com/traces

Demonstrates how to send events to the ingestion API using a cURL command, showing the HTTP POST request structure.

```shellscript
curl --request POST \
  --url http://localhost:3000/v1/events \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
  "data": [
    {
      "type": "llm",
      "id": "evt_abc123",
      "name": "llm_call",
      "tags": ["gpt-4"],
      "datasetId": "ds_xyz789",
      "timestamp": "2023-10-26T10:00:00Z",
      "metadata": {
        "prompt": "What is the capital of France?",
        "completion": "The capital of France is Paris.",
        "model": "gpt-4",
        "temperature": 0.7,
        "max_tokens": 100
      }
    }
  ]
}'
```

--------------------------------

### MDX Content Rendering Example

Source: https://docs.avidoai.com/traces

A JavaScript code snippet demonstrating how MDX content, including components like paragraphs, code blocks, tables, and headings, is rendered. This is typical for documentation sites built with frameworks like Next.js.

```javascript
function _createMdxContent(props) {
  const _components = {
    a: "a",
    br: "br",
    code: "code",
    em: "em",
    hr: "hr",
    li: "li",
    ol: "ol",
    p: "p",
    pre: "pre",
    span: "span",
    strong: "strong",
    table: "table",
    tbody: "tbody",
    td: "td",
    th: "th",
    thead: "thead",
    tr: "tr",
    ul: "ul",
    ..._provideComponents(),
    ...props.components
  };
  // ... component rendering logic ...
  return _jsxs(_Fragment, {
    children: [
      _jsxs(_components.p, {
        children: [
          "When your chatbot conversation or agent run is in flight, ",
          _jsxs(_components.strong, {
            children: [
              "every action becomes an ",
              _jsx(_components.em, {
                children: "event"
              })
            ]
          }),
          ".",
          _jsx(_components.br, {}),
          "\\n",
          "Bundled together they form a ",
          _jsx(_components.strong, {
            children: "trace"
          }),
          " – a structured replay of what happened, step‑by‑step."
        ]
      }),
      "\\n",
      _jsxs(_components.table, {
        children: [
          _jsx(_components.thead, {
            children: _jsxs(_components.tr, {
              children: [
                _jsx(_components.th, {
                  children: "Event"
                }),
                _jsx(_components.th,
                  {
                    children: "When to use"
                  }
                )
              ]
            })
          }),
          _jsxs(_components.tbody, {
            children: [
              _jsxs(_components.tr, {
                children: [
                  _jsx(_components.td, {
                    children: _jsx(_components.code, {
                      children: "trace"
                    })
                  }),
                  _jsx(_components.td, {
                    children: "The root container for a whole conversation / agent run."
                  })
                ]
              }),
              // ... other table rows ...
            ]
          })
        ]
      }),
      "\\n",
      _jsx(Info, {
        children: _jsxs(_components.p, {
          children: [
            "The full schema lives in ",
            _jsx("a", {
              href: "/api-reference/ingestion",
              target: "_blank",
              children: "API ▸ Inges"
            })
          ]
        })
      })
    ]
  });
}
```

--------------------------------

### Project Configuration Parameters

Source: https://docs.avidoai.com/api-reference

Details on various configuration settings for the project, including Git source information, AI service integration parameters, and application-specific providers. This data is crucial for understanding the project's setup and external service integrations.

```APIDOC
ProjectConfiguration:
  gitSource:
    type: string (e.g., "github")
    owner: string
    repo: string
    deployBranch: string
    contentDirectory: string
    isPrivate: boolean
  trieve:
    datasetId: string
    chatEnabled: boolean
  feedback:
    enabled: boolean
  subdomain: string
  actualSubdomain: string
  appId: string
  autoBoot: boolean
  auth: any
  userAuth: any

Example Usage:
{
  "gitSource": {
    "type": "github",
    "owner": "avido-ai",
    "repo": "avido",
    "deployBranch": "main",
    "contentDirectory": "apps/docs",
    "isPrivate": true
  },
  "trieve": {
    "datasetId": "799a46fa-5b2d-4d57-8cc2-eec6bab57f33",
    "chatEnabled": true
  },
  "feedback": {
    "enabled": true
  },
  "subdomain": "avido",
  "actualSubdomain": "avido",
  "appId": "$undefined",
  "autoBoot": true
}
```

--------------------------------

### Python Data Ingestion Example

Source: https://docs.avidoai.com/traces

A Python code example demonstrating how to log data, likely related to tool execution or ingestion. This snippet shows a basic print statement for logging.

```python
print("ingest".data)
```

--------------------------------

### Validate Avido AI Webhooks and Create Traces

Source: https://context7_llms

This example shows how to validate incoming Avido AI webhooks and process the payload to create trace events. It includes a cURL command for testing, and Node.js (TypeScript) and Python examples using the Avido SDK to handle the webhook verification and trace creation logic.

```curl
curl --request POST   --url https://api.avidoai.com/v0/validate-webhook   --header 'Content-Type: application/json'   --header 'x-api-key: <api-key>'   --data '{
    "signature": "abc123signature",
    "timestamp": 1687802842609,
    "body": {
      "testId": "123e4567-e89b-12d3-a456-426614174000",
      "prompt": "Write a concise onboarding email for new users."
    }
  }'
```

```typescript
import express from 'express';
import { Avido } from '@avidoai/sdk-node';

const app = express();
app.use(express.json());
const client = new Avido({ apiKey: process.env.AVIDO_API_KEY! });

app.post('/avido/webhook', async (req, res) => {
  const signature = req.get('x-avido-signature');
  const timestamp = req.get('x-avido-timestamp');
  const body = req.body;

  try {
    const { valid } = await client.validateWebhook({
      signature,
      timestamp,
      body
    });
    if (!valid) return res.status(401).send('Invalid webhook');

    const result = await runAgent(body.prompt); // 🤖 your LLM call

    await client.traces.create({
      testId: body.testId,
      input: body.prompt,
      output: result
    });

    return res.status(200).send('OK');
  } catch (err) {
    console.error(err);
    return res.status(500).send('Internal error');
  }
});
```

```python
import os
from flask import Flask, request, jsonify
from avido import Avido

app = Flask(__name__)
client = Avido(api_key=os.environ["AVIDO_API_KEY"])

@app.route("/avido/webhook", methods=["POST"])
def handle_webhook():
    body = request.get_json(force=True) or {}
    signature = request.headers.get("x-avido-signature")
    timestamp = request.headers.get("x-avido-timestamp")

    if not signature or not timestamp:
        return jsonify({"error": "Missing signature or timestamp"}), 400

    try:
        resp = client.validate_webhook.validate(
            signature=signature,
            timestamp=timestamp,
            body=body
        )
        if not resp.valid:
            return jsonify({"error": "Invalid webhook signature"}), 401
    except Exception as e:
        return jsonify({"error": str(e)}), 401

    result = run_agent(body.get("prompt"))  # your LLM pipeline

    client.traces.create(
        test_id=body.get("testId"),
        input=body.get("prompt"),
        output=result
    )
    return jsonify({"status": "ok"}), 200
```

--------------------------------

### Initialize Avido Client and Ingest Events

Source: https://docs.avidoai.com/traces

Demonstrates initializing the Avido client, retrieving the API key from environment variables, and initiating an event ingestion process with a sample event payload.

```python
import os
from avido import Avido

client = Avido(
    api_key=os.environ.get("AVIDO_API_KEY") # optional – defaults to env
)

ingest = client.ingest.create(
    events=[
        {
            "timestamp": "2025-05-15T12:34:56.123456Z",

```

--------------------------------

### Initialize Avido Client with API Key

Source: https://docs.avidoai.com/traces

This snippet demonstrates how to create a new instance of the Avido client. It requires an 'applicationId' and an 'apiKey', which can be sourced from environment variables for security. The API key is optional and defaults to an environment variable if not explicitly provided.

```javascript
const client = new Avido({
  applicationId: 'My Application ID',
  apiKey: process.env['AVIDO_API_KEY'] // optional – defaults to env
});
```

--------------------------------

### Mintlify Documentation Configuration

Source: https://docs.avidoai.com/quickstart

Configuration object for Mintlify, specifying theme, project name, and color settings. This indicates the project uses Mintlify for its documentation.

```json
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Avido",
  "colors": {
    "pri": "..."
  }
}
```

--------------------------------

### Next.js/React Initialization Script

Source: https://docs.avidoai.com/quickstart

This JavaScript snippet appears to be part of a Next.js application's client-side initialization. It configures the application's routing, asset loading, and potentially theme providers or other global settings. The code involves pushing configuration arrays to a global `__next_f` object, which is typical for Next.js internal scripts.

```javascript
self.__next_f=self.__next_f||[]
self.__next_f.push([0])
self.__next_f.push([1,"1:\"$Sreact.fragment\"\n2:I[47132,[],\"\"]\n3:I[55983,[\"7261\",\"static/chunks/7261-1f4bcac893329b6b.js\",\"9058\",\"static/chunks/9058-7f849e951ad85773.js\",\"8039\",\"static/chunks/app/error-dad69ef19d740480.js\"],\"default\"]\n4:I[75082,[],\"\"]\n"])
self.__next_f.push([1,"5:I[85506,[\"3473\",\"static/chunks/891cff7f-2ca7d0df884db9d0.js\",\"4129\",\"static/chunks/7bf36345-5ba13855b95a82b2.js\",\"1725\",\"static/chunks/d30757c7-d1a658b63aa94b97.js\",\"803\",\"static/chunks/cd24890f-549fb4ba2f588ca6.js\",\"7261\",\"static/chunks/7261-1f4bcac893329b6b.js\",\"3892\",\"static/chunks/3892-251b69e2384ed286.js\",\"7417\",\"static/chunks/7417-548f041b716e378a.js\",\"1953\",\"static/chunks/1953-639d64e349958881.js\",\"9095\",\"static/chunks/9095-5e8c25cebc4b2bd6.js\",\"9779\",\"static/chunks/9779-7bb45d52151006b8.js\",\"3619\",\"static/chunks/3619-3e497b0446e2fdfc.js\",\"2398\",\"static/chunks/2398-3c77a562bc9286bb.js\",\"1862\",\"static/chunks/1862-2618531eb3119cc9.js\",\"2755\",\"static/chunks/2755-e2a765a591a8496d.js\",\"1350\",\"static/chunks/1350-f25dfa5f4f88ddb4.js\",\"5456\",\"static/chunks/app/%255Fsites/%5Bsubdomain%5D/(multitenant)/layout-b596e085fd7c2d45.js\"],\"ThemeProvider\"]\n"])
self.__next_f.push([1,"6:I[81925,[\"7261\",\"static/chunks/7261-1f4bcac893329b6b.js\",\"9058\",\"static/chunks/9058-7f849e951ad85773.js\",\"9249\",\"static/chunks/app/%255Fsites/%5Bsubdomain%5D/error-d4ab46b84560464d.js\"],\"default\"]\n12:I[71256,[],\"\"]\n:HL[\"/mintlify-assets/_next/static/media/bb3ef058b751a6ad-s.p.woff2\",\"font\",{\"crossOrigin\":\"\",\"type\":\"font/woff2\"}]\n:HL[\"/mintlify-assets/_next/static/media/e4af272ccee01ff0-s.p.woff2\",\"font\",{\"crossOrigin\":\"\",\"type\":\"font/woff2\"}]\n:HL[\"/mintlify-assets/_next/static/css/ca797da4e9f8f21c.css\",\"style\"]\n:HL[\"/mintlify-assets/_next/static/css/f61b4e54ca51c353.css\",\"style\"]\n:HL[\"/mintlify-assets/_next/static/css/19e66b131dc509b0.css\",\"style\"]\n"])
self.__next_f.push([1,"0:{\"P\":null,\"b\":\"J5X0FjWc8NWmED0AfvH0Y\",\"p\":\"/mintlify-assets\",\"c\":[\"\",\"_sites\",\"docs.avidoai.com\",\"changelog\"],\"i\":false,\"f\":[[[\"\",{\"children\":[\"%5Fsites\",{\"children\":[[ \"subdomain\", \"docs.avidoai.com\", \"d\"],{\"children\":[\"(multitenant)\",{\"topbar\":[\"children\",{\"children\":[[ \"slug\", \"changelog\", \"oc\"],{\"children\":[\"__PAGE__\",{}]}]},\"children\":[[ \"slug\", \"changelog\", \"oc\"],{\"children\":[\"__PAGE__\",{}]}]}]}]}]}]}]})

```

--------------------------------

### Next.js Initialization Script

Source: https://docs.avidoai.com/traces

This snippet represents the initial JavaScript execution for a Next.js application. It includes pushing initialization data to a '__next_f' array, which is typical for Next.js client-side bootstrapping.

```javascript
self.__next_f = self.__next_f || [];
self.__next_f.push([0]);
```

--------------------------------

### Get Topic by ID API - APIDOC

Source: https://context7_llms

Retrieves detailed information about a specific topic using its unique identifier. This endpoint uses the GET HTTP method.

```APIDOC
openapi.json get /v0/topics/{id}
Retrieves detailed information about a specific topic.
```

--------------------------------

### Get Trace by ID API - APIDOC

Source: https://context7_llms

Retrieves detailed information about a specific trace using its unique identifier. This endpoint uses the GET HTTP method.

```APIDOC
openapi.json get /v0/traces/{id}
Retrieves detailed information about a specific trace.
```

--------------------------------

### Initialize Avido AI Client in TypeScript

Source: https://docs.avidoai.com/traces

Demonstrates how to import and initialize the Avido AI client in a TypeScript application. This involves creating a new instance of the Avido client with necessary configuration like the application ID.

```typescript
import Avido from 'avido';

const client = new Avido({
  applicationId: 'My Applicatio
```

--------------------------------

### Get Test by ID API - APIDOC

Source: https://context7_llms

Retrieves detailed information about a specific test using its unique identifier. This endpoint uses the GET HTTP method.

```APIDOC
openapi.json get /v0/tests/{id}
Retrieves detailed information about a specific test.
```

--------------------------------

### Applications API Reference

Source: https://docs.avidoai.com/quickstart

Manage your Avido applications, including listing existing applications, creating new ones, and retrieving details for a specific application.

```APIDOC
List Applications:
  Endpoint: GET /applications
  Description: Retrieves a list of all applications associated with your account.
  Parameters:
    - limit (optional, integer): Maximum number of applications to return.
    - offset (optional, integer): Number of applications to skip.
  Response:
    - 200 OK: Returns a list of application objects.

Create a New Application:
  Endpoint: POST /applications
  Description: Creates a new application within your Avido account.
  Request Body:
    - name (string, required): The name of the application.
    - description (string, optional): A brief description of the application.
  Response:
    - 201 Created: Returns the newly created application object.

Get a Single Application by ID:
  Endpoint: GET /applications/{applicationId}
  Description: Retrieves details for a specific application using its unique ID.
  Parameters:
    - applicationId (string, required): The unique identifier of the application.
  Response:
    - 200 OK: Returns the application object.
    - 404 Not Found: If an application with the specified ID does not exist.
```

--------------------------------

### Tests API: Get Test by ID

Source: https://docs.avidoai.com/quickstart

Retrieves detailed information about a specific test using its unique identifier. This endpoint is for individual test retrieval.

```APIDOC
GET /v0/tests/{id}
  Description: Retrieves detailed information about a specific test.
  Parameters:
    id (path parameter): The unique identifier of the test.
  Returns:
    A detailed test object.
```

--------------------------------

### List Topics API - APIDOC

Source: https://context7_llms

Retrieves a paginated list of topics, with support for optional filtering parameters. This endpoint uses the GET HTTP method.

```APIDOC
openapi.json get /v0/topics
Retrieves a paginated list of topics with optional filtering.
```

--------------------------------

### Applications API Reference

Source: https://docs.avidoai.com/quickstart

Manage applications within the Avido platform, including listing, creating, and retrieving specific applications.

```APIDOC
Applications API:
  list-applications:
    description: Retrieves a list of all applications.
    method: GET
    path: /applications
    responses:
      '200':
        description: A list of applications.
        content:
          application/json:
            schema:
              type: array
              items: { $ref: '#/components/schemas/Application' }

  create-a-new-application:
    description: Creates a new application.
    method: POST
    path: /applications
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              name: { type: string, description: The name of the application. }
              description: { type: string, description: A brief description of the application. }
    responses:
      '201':
        description: The created application.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
      '400':
        description: Invalid input data.

  get-a-single-application-by-id:
    description: Retrieves a specific application by its ID.
    method: GET
    path: /applications/{applicationId}
    parameters:
      - name: applicationId
        in: path
        required: true
        schema: { type: string }
    responses:
      '200':
        description: The requested application.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
      '404':
        description: Application not found.
```

--------------------------------

### MDX Reference Error Handling

Source: https://docs.avidoai.com/traces

A utility function to throw an error when an MDX reference is missing, guiding the developer to import or provide the necessary component or object.

```javascript
function _missingMdxReference(id, component) {
  throw new Error("Expected " + (component ? "component" : "object") + " \"" + id + "\" to be defined: you likely forgot to import, pass, or provide it.");
}
```

--------------------------------

### Ingest Events with Avido SDK

Source: https://context7_llms

Example of using the Avido SDK to send collected events for tracing. This function is typically called when your application's workflow completes.

```typescript
client.ingest.create({ events })
```

--------------------------------

### List Traces API - APIDOC

Source: https://context7_llms

Retrieves a list of threads with associated traces. Supports filtering by application ID and optional date parameters. This endpoint uses the GET HTTP method.

```APIDOC
openapi.json get /v0/traces
Retrieve threads with associated traces, filtered by application ID and optional date parameters.
```