> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gloo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Real-time ingestion
> Real-time ingestion.
**This endpoint has been deprecated.** Use the [Direct File Upload API](/api-reference/ingestion/v2) instead.
## Authentication
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.
### JWT Token Requirements
Your JWT must include the following claims:
* A `sub` claim containing your API Client ID.
* A `scope` claim that includes `api/access`.
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.
## OpenAPI
````yaml post /ingestion/v1/real_time_upload
openapi: 3.1.0
info:
title: AI API
description: |-
Optimized for high-speed inference and scalability by Gloo AI
[Swagger UI](./docs) | [ReDoc UI](./redoc)
version: 1.0.0
servers:
- url: https://platform.ai.gloo.com
security:
- bearerAuth: []
tags:
- name: Content Controls
- name: Data Engine
- name: Ingestion & Enrichment
- name: answers
- name: chat
- name: completions
- name: content
- name: core
- name: data
- name: get-models
- name: ingestion
- name: sotc
paths:
/ingestion/v1/real_time_upload:
post:
tags:
- ingestion
summary: Real-time ingestion
description: Real-time ingestion.
operationId: real_time_upload
requestBody:
description: 'The request body should be a JSON object with the following structure:'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RealTimeIngestionRequest'
example:
content: >-
This is the full text content that needs to be processed and
indexed for search. It is the only required field.
filename: sample_document_name.txt
producer_id: producer-123
publisher_id: 550e8400-e29b-41d4-a716-446655440000
tradition: 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
responses:
'200':
description: Content successfully uploaded and processed.
'400':
description: Bad Request - The request was improperly formatted.
'401':
description: Unauthorized - The JWT token is missing or invalid.
'422':
description: >-
Unprocessable Entity - The request is well-formed but contains
semantic errors.
deprecated: true
security:
- bearerAuth: []
components:
schemas:
RealTimeIngestionRequest:
type: object
required:
- publisher_id
- content
properties:
publisher_id:
type: string
format: uuid
description: >-
UUID of the publisher associated with the content. This must be
associated with your organization.
content:
type: string
description: The actual text content to be ingested and chunked.
filename:
type: string
description: Custom filename for this content.
type:
type: string
description: Content type (e.g., article, blog, tutorial).
item_title:
type: string
description: Title of the content item.
item_subtitle:
type: string
description: Subtitle of the content item.
item_summary:
type: string
description: Brief summary of the content.
item_image:
type: string
format: uri
description: URL to image associated with the content.
item_url:
type: string
format: uri
description: URL to the original content.
item_file:
type: string
format: uri
description: URL to a file associated with the content.
item_number:
type: string
description: Identifying number for the content item.
item_extra:
type: string
description: Additional information about the content item.
item_tags:
oneOf:
- type: array
items:
type: string
- type: string
description: >-
Tags associated with the content (can be array or comma-separated
string).
author:
oneOf:
- type: array
items:
type: string
- type: string
description: Author(s) of the content (can be array or comma-separated string).
isbn:
type: string
description: ISBN if content is from a book.
publication_date:
type: string
format: date
description: >-
Date when the content was published (recommended format:
YYYY-MM-DD).
producer_id:
type: string
description: ID of the content producer.
tradition:
type: string
description: Religious tradition (if applicable).
pub_type:
type: string
description: Publication type.
hosted_url:
type: string
format: uri
description: URL where the content is hosted.
pages:
type: string
description: Number of pages (for documents).
duration:
type: string
description: Duration (for audio/video content).
h2_title:
type: string
description: Title for level 2 heading/section.
h2_subtitle:
type: string
description: Subtitle for level 2 heading/section.
h2_image:
type: string
format: uri
description: Image URL for level 2 heading/section.
h2_url:
type: string
format: uri
description: URL for level 2 heading/section.
h2_file:
type: string
format: uri
description: File URL for level 2 heading/section.
h2_summary:
type: string
description: Summary for level 2 heading/section.
h2_number:
type: string
description: Number for level 2 heading/section.
h2_extra:
type: string
description: Additional info for level 2 heading/section.
h3_title:
type: string
description: Title for level 3 heading/section.
h3_subtitle:
type: string
description: Subtitle for level 3 heading/section.
h3_image:
type: string
format: uri
description: Image URL for level 3 heading/section.
h3_url:
type: string
format: uri
description: URL for level 3 heading/section.
h3_file:
type: string
format: uri
description: File URL for level 3 heading/section.
h3_summary:
type: string
description: Summary for level 3 heading/section.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Bearer authentication header of the form Bearer ``, where
`` is your [auth token](/studio/manage-api-credentials).
````