Skip to main content
POST
/
v0
/
ingest
Ingest events
curl --request POST \
  --url https://api.avidoai.com/v0/ingest \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "events": [
    {
      "type": "trace",
      "timestamp": "2025-01-01T12:00:00Z",
      "referenceId": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "source": "chatbot"
      }
    },
    {
      "type": "llm",
      "event": "start",
      "traceId": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": "2025-01-01T12:01:00Z",
      "modelId": "gpt-4o-2024-08-06",
      "params": {
        "temperature": 1.2
      },
      "input": [
        {
          "role": "user",
          "content": "Tell me a joke."
        }
      ]
    }
  ]
}
'
{
  "data": [
    {
      "success": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "error": "Failed to write to database"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request schema for ingesting events into the system.

​
events
(Trace · object | LLM Start Trace · object | LLM End Trace · object | Tool Step · object | Retriever Step · object | Log Step · object | Group Step · object | Response Step · object)[]
required

Array of events to be ingested, which can be traces or steps.

A trace grouping related steps (e.g. a user-agent interaction or conversation).

Example:
[
  {
    "type": "trace",
    "timestamp": "2025-01-01T12:00:00Z",
    "referenceId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": { "source": "chatbot" }
  },
  {
    "type": "llm",
    "event": "start",
    "traceId": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2025-01-01T12:01:00Z",
    "modelId": "gpt-4o-2024-08-06",
    "params": { "temperature": 1.2 },
    "input": [
      {
        "role": "user",
        "content": "Tell me a joke."
      }
    ]
  }
]

Response

Successfully ingested events.

Response schema for successful event ingestion.

​
data
object[]
required

Array of results for each ingested event.