Skip to main content
POST
/
v0
/
inference-steps
Create an inference step
curl --request POST \
  --url https://api.avidoai.com/v0/inference-steps \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Moderator",
  "description": "Moderator step for input moderation",
  "type": "LLM",
  "externalId": "input_moderator"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "type": "LLM",
    "externalId": "input_moderator",
    "title": "Moderator",
    "description": "Moderator step for input moderation"
  }
}

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 body for creating a new inference step

​
title
string
required

The title of the inference step

Required string length: 1 - 255
Example:

"Moderator"

​
description
string
required

The inference step description

Example:

"Moderator step for input moderation"

​
type
enum<string>
required

The type of the inference step

Available options:
LLM,
RETRIEVER
Example:

"LLM"

​
externalId
string
required

identifier used in the ai application

Required string length: 1 - 255
Example:

"input_moderator"

Response

Created

Response containing a single inference step

​
data
object
required