The Real-Time Ingestion API allows developers to upload text content directly for immediate processing and vectorization. Unlike batch upload methods, this API processes content in real-time, making it suitable for dynamic content that needs to be immediately available for search or retrieval.

​
Uploading Content

​
Prerequisites

Before making a request, grab your Publisher ID:
  1. Navigate to your Organization in Studio.
  2. Click on the “View Publishers” button.
  3. Locate your publisher.
  4. Copy the Publisher ID from the page.
If you haven’t set up a publisher yet, follow the Create a Publisher guide.

​
Authentication

You need an API access token to upload content. Follow these steps to obtain one:
  1. Visit the API Credentials page.
  2. Generate a token using the OAuth2 Client Credentials flow.
  3. Use the generated token in your requests.
The API requires a JWT token with specific claims to authorize access. The token must be associated with a Client ID that has access to the specified publisher. The system validates that the organization associated with your Client ID has permission to access the publisher specified in your request. Your JWT must include the following claims:
  • A sub claim containing your API Client ID.
  • A scope claim that includes api/access.

​
API request

Once you have your publisher id and API access token, you’re ready to upload content. Endpoint: POST /ingestion/v1/real_time_upload

​
Example cURL Request

cURL
curl 'https://platform.ai.gloo.com/ai/ingestion/v1/real_time_upload' -v \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -d '${REQUEST_BODY}'
The request body should be a single JSON object containing the content and any relevant metadata.

​
Example Request Body

JSON
{
  "content": "This is the full text content that needs to be processed and indexed for search. It can be as long as needed to represent the document content.",
  "filename": "sample_document_name.txt",
  "producer_id": "producer-123",
  "publisher_id": "550e8400-e29b-41d4-a716-446655440000",
  "denomination": "Catholic",
  "evergreen": true,
  "drm": ["aspen", "kallm"],
  "author": ["Jane Doe", "John Smith"],
  "isbn": "978-3-16-148410-0",

  "item_title": "Main Document Title",
  "item_subtitle": "An Informative Subtitle",
  "item_image": "https://example.com/images/document-cover.jpg",
  "item_url": "https://example.com/original-content",
  "item_file": "https://example.com/downloads/document.pdf",
  "item_summary": "A brief summary of the document's content and purpose.",
  "item_number": "DOC-2023-001",
  "item_extra": "Additional information about this item",
  "item_tags": ["documentation", "api", "tutorial", "reference"],

  "h2_title": "Section Heading",
  "h2_subtitle": "Section Subheading",
  "h2_image": "https://example.com/images/section-image.jpg",
  "h2_url": "https://example.com/section",
  "h2_file": "https://example.com/downloads/section.pdf",
  "h2_summary": "Summary of this specific section",
  "h2_number": "2.1",
  "h2_extra": "Additional section metadata",

  "h3_title": "Subsection Heading",
  "h3_subtitle": "Subsection Subheading",
  "h3_image": "https://example.com/images/subsection-image.jpg",
  "h3_url": "https://example.com/subsection",
  "h3_file": "https://example.com/downloads/subsection.pdf",
  "h3_summary": "Summary of this specific subsection",
  "h3_number": "2.1.3",
  "h3_extra": "Additional subsection metadata",

  "type": "Article",
  "duration": "15 minutes",
  "pages": "12",
  "publication_date": "2023-07-15",
  "hosted_url": "https://cdn.example.com/hosted-content",
  "pub_type": "technical"
}
You will only be able to send content to a publisher that belongs to your organization. Please double-check the publisher_id field in the request body for accuracy.

​
Fields and Metadata

​
Core Required Fields

These fields are mandatory for every request.
FieldTypeDescription
publisher_idStringUUID of the publisher associated with the content. This must be associated with your organization.
contentStringThe actual text content to be ingested and chunked.

​
All Available Metadata

The following tables list all the optional metadata fields you can include to enrich your content for better search and retrieval.

​
General Metadata

FieldTypeRequiredDescription
contentStringYesText content to be ingested and chunked.
filenameStringNoCustom filename for this content.
typeStringNoContent type (e.g., article, blog, tutorial).
item_titleStringNo*Title of the content item. (*Required if no h2_title)
item_subtitleStringNoSubtitle of the content item.
item_summaryStringNoBrief summary of the content.
item_imageStringNoURL to an image associated with the content.
item_urlStringNoURL to the original content.
item_fileStringNoURL to a file associated with the content.
item_numberStringNoIdentifying number for the content item.
item_extraStringNoAdditional information about the content item.
item_tagsArray or StringNoTags associated with the content.

​
Author and Publishing Information

FieldTypeRequiredDescription
authorArray or StringNoAuthor(s) of the content.
isbnStringNoISBN if content is from a book.
publication_dateStringNoDate when the content was published (YYYY-MM-DD).
producer_idStringNoID of the content producer.
denominationStringNoReligious denomination (if applicable).
pub_typeStringNoPublication type.
hosted_urlStringNoURL where the content is hosted.
pagesStringNoNumber of pages (for documents).
durationStringNoDuration (for audio/video content).

​
Hierarchical Structure (for organized content)

FieldTypeRequiredDescription
h2_titleStringNoTitle for level 2 heading/section.
h2_subtitleStringNoSubtitle for level 2 heading.
h2_imageStringNoImage URL for level 2 section.
h2_urlStringNoURL for level 2 heading/section.
h2_fileStringNoFile URL for level 2 heading/section.
h2_summaryStringNoSummary for level 2 heading/section.
h2_numberStringNoNumber for level 2 heading/section.
h2_extraStringNoAdditional info for level 2 heading/section.
h3_titleStringNoTitle for level 3 heading/section.
h3_subtitleStringNoSubtitle for level 3 heading.
h3_imageStringNoImage URL for level 3 section.
h3_urlStringNoURL for level 3 heading/section.
h3_fileStringNoFile URL for level 3 heading/section.
h3_summaryStringNoSummary for level 3 heading/section.