Skip to main content
POST
/
onyx-api
/
ingestion
Upsert Ingestion Doc
curl --request POST \
  --url https://cloud.onyx.app/api/onyx-api/ingestion \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "sections": [
      {
        "text": "<string>",
        "link": "<string>",
        "image_file_id": "<string>"
      }
    ],
    "semantic_identifier": "<string>",
    "metadata": {},
    "id": "<string>",
    "doc_updated_at": "2023-11-07T05:31:56Z",
    "chunk_count": 123,
    "primary_owners": [
      {
        "display_name": "<string>",
        "first_name": "<string>",
        "middle_initial": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      }
    ],
    "secondary_owners": [
      {
        "display_name": "<string>",
        "first_name": "<string>",
        "middle_initial": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      }
    ],
    "title": "<string>",
    "from_ingestion_api": false,
    "additional_info": "<unknown>",
    "external_access": {
      "external_user_emails": [
        "<string>"
      ],
      "external_user_group_ids": [
        "<string>"
      ],
      "is_public": true
    },
    "doc_metadata": {}
  },
  "cc_pair_id": 123
}
'
import requests

url = "https://cloud.onyx.app/api/onyx-api/ingestion"

payload = {
    "document": {
        "sections": [
            {
                "text": "<string>",
                "link": "<string>",
                "image_file_id": "<string>"
            }
        ],
        "semantic_identifier": "<string>",
        "metadata": {},
        "id": "<string>",
        "doc_updated_at": "2023-11-07T05:31:56Z",
        "chunk_count": 123,
        "primary_owners": [
            {
                "display_name": "<string>",
                "first_name": "<string>",
                "middle_initial": "<string>",
                "last_name": "<string>",
                "email": "<string>"
            }
        ],
        "secondary_owners": [
            {
                "display_name": "<string>",
                "first_name": "<string>",
                "middle_initial": "<string>",
                "last_name": "<string>",
                "email": "<string>"
            }
        ],
        "title": "<string>",
        "from_ingestion_api": False,
        "additional_info": "<unknown>",
        "external_access": {
            "external_user_emails": ["<string>"],
            "external_user_group_ids": ["<string>"],
            "is_public": True
        },
        "doc_metadata": {}
    },
    "cc_pair_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document: {
      sections: [{text: '<string>', link: '<string>', image_file_id: '<string>'}],
      semantic_identifier: '<string>',
      metadata: {},
      id: '<string>',
      doc_updated_at: '2023-11-07T05:31:56Z',
      chunk_count: 123,
      primary_owners: [
        {
          display_name: '<string>',
          first_name: '<string>',
          middle_initial: '<string>',
          last_name: '<string>',
          email: '<string>'
        }
      ],
      secondary_owners: [
        {
          display_name: '<string>',
          first_name: '<string>',
          middle_initial: '<string>',
          last_name: '<string>',
          email: '<string>'
        }
      ],
      title: '<string>',
      from_ingestion_api: false,
      additional_info: '<unknown>',
      external_access: {
        external_user_emails: ['<string>'],
        external_user_group_ids: ['<string>'],
        is_public: true
      },
      doc_metadata: {}
    },
    cc_pair_id: 123
  })
};

fetch('https://cloud.onyx.app/api/onyx-api/ingestion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.onyx.app/api/onyx-api/ingestion",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document' => [
        'sections' => [
                [
                                'text' => '<string>',
                                'link' => '<string>',
                                'image_file_id' => '<string>'
                ]
        ],
        'semantic_identifier' => '<string>',
        'metadata' => [
                
        ],
        'id' => '<string>',
        'doc_updated_at' => '2023-11-07T05:31:56Z',
        'chunk_count' => 123,
        'primary_owners' => [
                [
                                'display_name' => '<string>',
                                'first_name' => '<string>',
                                'middle_initial' => '<string>',
                                'last_name' => '<string>',
                                'email' => '<string>'
                ]
        ],
        'secondary_owners' => [
                [
                                'display_name' => '<string>',
                                'first_name' => '<string>',
                                'middle_initial' => '<string>',
                                'last_name' => '<string>',
                                'email' => '<string>'
                ]
        ],
        'title' => '<string>',
        'from_ingestion_api' => false,
        'additional_info' => '<unknown>',
        'external_access' => [
                'external_user_emails' => [
                                '<string>'
                ],
                'external_user_group_ids' => [
                                '<string>'
                ],
                'is_public' => true
        ],
        'doc_metadata' => [
                
        ]
    ],
    'cc_pair_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.onyx.app/api/onyx-api/ingestion"

	payload := strings.NewReader("{\n  \"document\": {\n    \"sections\": [\n      {\n        \"text\": \"<string>\",\n        \"link\": \"<string>\",\n        \"image_file_id\": \"<string>\"\n      }\n    ],\n    \"semantic_identifier\": \"<string>\",\n    \"metadata\": {},\n    \"id\": \"<string>\",\n    \"doc_updated_at\": \"2023-11-07T05:31:56Z\",\n    \"chunk_count\": 123,\n    \"primary_owners\": [\n      {\n        \"display_name\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"middle_initial\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    ],\n    \"secondary_owners\": [\n      {\n        \"display_name\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"middle_initial\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    ],\n    \"title\": \"<string>\",\n    \"from_ingestion_api\": false,\n    \"additional_info\": \"<unknown>\",\n    \"external_access\": {\n      \"external_user_emails\": [\n        \"<string>\"\n      ],\n      \"external_user_group_ids\": [\n        \"<string>\"\n      ],\n      \"is_public\": true\n    },\n    \"doc_metadata\": {}\n  },\n  \"cc_pair_id\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://cloud.onyx.app/api/onyx-api/ingestion")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document\": {\n    \"sections\": [\n      {\n        \"text\": \"<string>\",\n        \"link\": \"<string>\",\n        \"image_file_id\": \"<string>\"\n      }\n    ],\n    \"semantic_identifier\": \"<string>\",\n    \"metadata\": {},\n    \"id\": \"<string>\",\n    \"doc_updated_at\": \"2023-11-07T05:31:56Z\",\n    \"chunk_count\": 123,\n    \"primary_owners\": [\n      {\n        \"display_name\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"middle_initial\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    ],\n    \"secondary_owners\": [\n      {\n        \"display_name\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"middle_initial\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    ],\n    \"title\": \"<string>\",\n    \"from_ingestion_api\": false,\n    \"additional_info\": \"<unknown>\",\n    \"external_access\": {\n      \"external_user_emails\": [\n        \"<string>\"\n      ],\n      \"external_user_group_ids\": [\n        \"<string>\"\n      ],\n      \"is_public\": true\n    },\n    \"doc_metadata\": {}\n  },\n  \"cc_pair_id\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/onyx-api/ingestion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": {\n    \"sections\": [\n      {\n        \"text\": \"<string>\",\n        \"link\": \"<string>\",\n        \"image_file_id\": \"<string>\"\n      }\n    ],\n    \"semantic_identifier\": \"<string>\",\n    \"metadata\": {},\n    \"id\": \"<string>\",\n    \"doc_updated_at\": \"2023-11-07T05:31:56Z\",\n    \"chunk_count\": 123,\n    \"primary_owners\": [\n      {\n        \"display_name\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"middle_initial\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    ],\n    \"secondary_owners\": [\n      {\n        \"display_name\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"middle_initial\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    ],\n    \"title\": \"<string>\",\n    \"from_ingestion_api\": false,\n    \"additional_info\": \"<unknown>\",\n    \"external_access\": {\n      \"external_user_emails\": [\n        \"<string>\"\n      ],\n      \"external_user_group_ids\": [\n        \"<string>\"\n      ],\n      \"is_public\": true\n    },\n    \"doc_metadata\": {}\n  },\n  \"cc_pair_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "document_id": "<string>",
  "already_existed": true
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
​
document
DocumentBase · object
required

Used for Onyx ingestion api, the ID is inferred before use if not provided

​
cc_pair_id
integer | null

Response

Successful Response

​
document_id
string
required
​
already_existed
boolean
required