Skip to main content
Knowledge Intelligence

Ask FinanceGPT against permission-scoped Knowledge Intelligence evidence

POST /knowledge/query

Contract

Retrieval fails closed when no accessible evidence matches. Managed AI consumes FinanceGPT AI Credits under AI3 enforcement; BYOK remains customer-provider-direct under AI6/AI7 policy.

Authentication
Bearer credential required
Required scope
Operation-specific / public
Status
Published

Request body

application/json ยท required
{
    "question": "string",
    "base_uid": "00000000-0000-4000-8000-000000000001",
    "document_uid": "00000000-0000-4000-8000-000000000001",
    "model_selection": "auto_native",
    "financegpt_model": "financegpt-research"
}

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X POST \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "question": "string",
    "base_uid": "00000000-0000-4000-8000-000000000001",
    "document_uid": "00000000-0000-4000-8000-000000000001",
    "model_selection": "auto_native",
    "financegpt_model": "financegpt-research"
}' \
  "https://financegpt.dev/api/v2/knowledge/query"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/knowledge\/query", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "question": "string",
    "base_uid": "00000000-0000-4000-8000-000000000001",
    "document_uid": "00000000-0000-4000-8000-000000000001",
    "model_selection": "auto_native",
    "financegpt_model": "financegpt-research"
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/knowledge/query',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"question":"string","base_uid":"00000000-0000-4000-8000-000000000001","document_uid":"00000000-0000-4000-8000-000000000001","model_selection":"auto_native","financegpt_model":"financegpt-research"}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/knowledge/query');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode(array (
  'question' => 'string',
  'base_uid' => '00000000-0000-4000-8000-000000000001',
  'document_uid' => '00000000-0000-4000-8000-000000000001',
  'model_selection' => 'auto_native',
  'financegpt_model' => 'financegpt-research',
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
200 Source-grounded answer with citations and AI billing mode
409 AI route unavailable or credit/provider policy requires user action

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

Machine-readable sources