Skip to main content
Knowledge Intelligence

Ingest a document into a workspace-visible knowledge base

POST /knowledge/documents

Contract

Stores the raw file privately and extracts deterministic source lineage. Image-only PDFs require a separately configured OCR-capable ingestion path.

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

Request body

multipart/form-data ยท required
{
    "base_uid": "00000000-0000-4000-8000-000000000001",
    "file": "string",
    "title": "string",
    "data_classification": "public"
}

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 '{
    "base_uid": "00000000-0000-4000-8000-000000000001",
    "file": "string",
    "title": "string",
    "data_classification": "public"
}' \
  "https://financegpt.dev/api/v2/knowledge/documents"

javascript

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

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/knowledge/documents',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"base_uid":"00000000-0000-4000-8000-000000000001","file":"string","title":"string","data_classification":"public"}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/knowledge/documents');
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 (
  'base_uid' => '00000000-0000-4000-8000-000000000001',
  'file' => 'string',
  'title' => 'string',
  'data_classification' => 'public',
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Document ingested
422 File stored but extraction failed or was unsupported

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