Skip to main content
POST
/
api
/
triples
/
generate
curl --request POST \
  --url https://neode.ai/api/triples/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "query": "Extract facts about Tesla's Q4 2025 earnings",
  "index_id": "550e8400-e29b-41d4-a716-446655440000",
  "triple_count": 10
}
EOF
{
  "success": true,
  "data": [
    {
      "subject": "<string>",
      "predicate": "<string>",
      "object": "<string>",
      "object_type": "literal",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "confidence": 0.5,
      "source": "<string>",
      "graph_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subject_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123,
  "provider": "<string>",
  "credits_used": 123,
  "balance_remaining": 123
}

Authorizations

Authorization
string
header
required

API key for authentication

Query Parameters

format
enum<string>
default:stream

Response format. Use 'json' for non-streaming response suitable for tool use.

Available options:
stream,
json

Body

application/json

Request to generate triples using AI (OpenAI)

query
string
required

Natural language description of what to extract triples about

index_id
string<uuid>
required

Index for entity disambiguation (required)

graph_id
string<uuid>

Graph to store generated triples in

Enable web search for real-time information

triple_count
integer
default:10

Target number of triples to generate (approximate)

Required range: 1 <= x <= 50
predicates
string[]

Restrict to specific predicate types

Response

Generated triples (streaming or JSON based on format parameter)

success
boolean
data
object[]
count
integer
provider
string

AI provider used (openai)

credits_used
integer

Credits deducted for generation

balance_remaining
integer

Remaining credit balance