Skip to main content
POST
/
v0
/
facts
Create a new fact
curl --request POST \
  --url https://api.avidoai.com/v0/facts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "statement": "The refund policy allows returns within 30 days of purchase.",
  "scope": "TOPIC",
  "status": "ACTIVE",
  "sourceQuote": "Returns are accepted within 30 days.",
  "sourceDocumentId": "123e4567-e89b-12d3-a456-426614174000",
  "quickstartId": "123e4567-e89b-12d3-a456-426614174000",
  "generatedBy": "MANUAL",
  "topicIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org-123",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "quickstartId": "123e4567-e89b-12d3-a456-426614174000",
    "sourceDocumentId": "123e4567-e89b-12d3-a456-426614174000",
    "statement": "The refund policy allows returns within 30 days of purchase.",
    "scope": "TOPIC",
    "status": "ACTIVE",
    "sourceQuote": "Returns are accepted within 30 days.",
    "generatedBy": "MANUAL",
    "topics": [
      {
        "id": "789e4567-e89b-12d3-a456-426614174000",
        "orgId": "org_123456",
        "title": "Code Quality",
        "baseline": 0.85,
        "status": "ACTIVE",
        "isTasksVerified": false,
        "isDocumentsVerified": false,
        "createdAt": "2024-01-05T12:34:56.789Z",
        "modifiedAt": "2024-01-05T12:34:56.789Z",
        "applicationId": "456e4567-e89b-12d3-a456-426614174000",
        "assignedTo": "user_789012",
        "assignedUser": {
          "id": "user_789012",
          "name": "John Doe",
          "email": "john@example.com",
          "image": "https://example.com/avatar.jpg"
        },
        "evalDefinitions": [
          {
            "topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "evalDefinition": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "createdAt": "2024-01-05T12:34:56.789Z",
              "modifiedAt": "2024-01-05T12:34:56.789Z",
              "type": "NATURALNESS",
              "name": "<string>",
              "globalConfig": {
                "criterion": "<string>"
              },
              "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "application": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "orgId": "org_123456",
                "title": "Customer Support Bot",
                "slug": "customer-support-bot",
                "description": "AI assistant for customer support inquiries",
                "context": "You are a helpful customer support assistant...",
                "language": "en",
                "type": "CHATBOT",
                "environment": "DEV",
                "createdAt": "2024-01-05T12:34:56.789Z",
                "modifiedAt": "2024-01-05T12:34:56.789Z"
              }
            },
            "config": {
              "expected": "<string>"
            }
          }
        ]
      }
    ]
  }
}

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 fact

statement
string
required

The fact statement text

Required string length: 1 - 10000
Example:

"The refund policy allows returns within 30 days of purchase."

scope
enum<string>
required

The scope of the fact. TOPIC means it applies to specific topics, APPLICATION means it applies globally.

Available options:
TOPIC,
APPLICATION
Example:

"TOPIC"

status
enum<string>

The initial status (defaults to DRAFT)

Available options:
DRAFT,
ACTIVE
Example:

"ACTIVE"

sourceQuote
string · null · null

The original quote from the source document

Maximum string length: 10000
Example:

"Returns are accepted within 30 days."

sourceDocumentId
string<uuid> · null · null

The ID of the source document

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

quickstartId
string<uuid> · null · null

The ID of the associated quickstart

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

generatedBy
enum<string>

How the fact was generated (defaults to MANUAL)

Available options:
MANUAL,
QUICKSTART
Example:

"MANUAL"

topicIds
string<uuid>[]

Topic IDs to link this fact to

Maximum array length: 100
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successfully created fact

Successful response containing the fact data

data
Fact · object
required

A knowledge fact for a specific application