Pryon Content Service API

openapi: 3.2.0
info:
  title: Pryon Content Service API
  version: '1.0'
  contact:
    name: Pryon Product Support
    url: https://pryon.zendesk.com
    email: support@pryon.zendesk.com
  x-logo:
    altText: Pryon APIs
  description: 'Operations tagged Content Service across 2 of this provider''s published API definitions: pryon-content-service-api-openapi.yml, pryon-retrieval-may2025-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.pryon.net
  description: Pryon Cloud
tags:
- name: Content Service
paths:
  /api/knowledge/v1alpha1/content-groups:
    get:
      operationId: ContentService_ListContentGroups
      parameters:
      - description: Unique identifier of the knowledge domain that supplied the exchange response.
        in: query
        name: knowledge_domain_id
        schema:
          type: string
      - description: Unique identifier for the content within the matching content groups.
        in: query
        name: content_id
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1ListContentGroupsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: List Content Groups
      tags:
      - Content Service
      description: Filter content groups by knowledge domain and content.
    post:
      operationId: ContentService_CreateContentGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filename_v1alpha1CreateContentGroupRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentGroupResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Create Content Group
      tags:
      - Content Service
      x-codegen-request-body-name: body
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/content-groups/{content_group_id}:
    delete:
      operationId: ContentService_DeleteContentGroup
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Delete Content Group
      tags:
      - Content Service
      description: Delete a content group without altering the content resources.
    get:
      operationId: ContentService_GetContentGroup
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentGroupResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Get Content Group
      tags:
      - Content Service
      description: Retrieve a content group using the ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/content-groups/{content_group_id}/contents:
    delete:
      operationId: ContentService_DeleteContentGroupContents
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Delete Content Group Contents
      tags:
      - Content Service
      description: Delete all child content associations with the parent content group.
    get:
      operationId: ContentService_ListContentGroupContents
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - description: Maximum page size is 100; default is 100.
        in: query
        name: page_size
        schema:
          format: int32
          type: integer
      - description: For multiple pages; must be specified in each request for two pages per sheet.
        in: query
        name: page_token
        schema:
          type: string
      - description: If set to True will only return item IDs.
        in: query
        name: return_only_id
        schema:
          type: boolean
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1ListContentGroupContentsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: List Content Group Contents
      tags:
      - Content Service
      description: List content group sources by ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/content-groups/{content_group_id}/contents/{content_id}:
    delete:
      operationId: ContentService_DeleteContentGroupContent
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Delete Content Group Content
      tags:
      - Content Service
      description: Delete content associations within the parent content group.
    get:
      operationId: ContentService_GetContentGroupContent
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentGroupContentResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Get Content Group Content
      tags:
      - Content Service
      description: Get content group sources by ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/content-groups/{content_group_id}:cascade:
    delete:
      operationId: ContentService_CascadeDeleteContentGroup
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: content_group_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Cascade Delete Content Group
      tags:
      - Content Service
      description: Delete content group source associations and remove from knowledge domain.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/content-groups/{data.content_group_id}:
    patch:
      operationId: ContentService_UpdateContentGroup
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: data.content_group_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentGroupResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Update Content Group
      tags:
      - Content Service
      description: Update the display name for a content group.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/content-groups/{data.content_group_id}/contents/{data.content_id}:
    post:
      operationId: ContentService_CreateContentGroupContent
      parameters:
      - description: Unique identifier for the content group.
        in: path
        name: data.content_group_id
        required: true
        schema:
          type: string
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: data.content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filename_v1alpha1ContentGroupContentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentGroupContentResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Create Content Group Content
      tags:
      - Content Service
      x-codegen-request-body-name: body
      description: Create content group sources.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents:
    get:
      operationId: ContentService_ListContents
      parameters:
      - description: Unique identifier of the knowledge domain that supplied the exchange response.
        in: query
        name: knowledge_domain_id
        schema:
          type: string
      - description: Unique identifier for the content within the matching content groups.
        in: query
        name: content_group_id
        schema:
          type: string
      - description: Precise location of the source material.
        in: query
        name: source_location
        schema:
          type: string
      - description: Maximum page size is 100; default is 100.
        in: query
        name: page_size
        schema:
          format: int32
          type: integer
      - description: For multiple pages; must be specified in each request for two pages per sheet.
        in: query
        name: page_token
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1ListContentsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: List Contents
      tags:
      - Content Service
      description: List contents associated with a knowledge domain.
    post:
      operationId: ContentService_CreateContent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filename_v1alpha1CreateContentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Create Content
      tags:
      - Content Service
      x-codegen-request-body-name: body
      description: Create methods for contents.
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}:
    delete:
      operationId: ContentService_DeleteContent
      parameters:
      - description: Unique identifier for the content to be deleted.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Delete Content
      tags:
      - Content Service
      description: Delete the content and all child resources.
    get:
      operationId: ContentService_GetContent
      parameters:
      - description: Unique identifier for the content to be returned.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      tags:
      - Content Service
      summary: Get Content
      description: ''
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}/image:
    get:
      operationId: ContentService_GetContentImage
      parameters:
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - description: Page number in the content.
        in: query
        name: page
        schema:
          format: int32
          type: integer
      - description: True does not compress the image data; default is false (compressed).
        in: query
        name: uncompressed
        schema:
          type: boolean
      - description: True returns a debug image.
        in: query
        name: debug
        schema:
          type: boolean
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Get Content Image
      tags:
      - Content Service
      description: Return an image representation of the content.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}/processed-extracts:
    get:
      operationId: ContentService_ListProcessedContentExtracts
      parameters:
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - description: Unique identifier of the knowledge domain that contains the exchange response.
        in: query
        name: knowledge_domain_id
        schema:
          type: string
      - description: Maximum page size is 100; default is 100.
        in: query
        name: page_size
        schema:
          format: int32
          type: integer
      - description: For multiple pages; must be specified in each request for two pages per sheet.
        in: query
        name: page_token
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1ListProcessedContentExtractsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: List Processed Content Extracts
      tags:
      - Content Service
      description: List initial processed extracts by content ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}/retrieval-extracts:
    get:
      operationId: ContentService_ListRetrievalContentExtracts
      parameters:
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - description: Unique identifier of the knowledge domain that supplied the exchange response.
        in: query
        name: knowledge_domain_id
        schema:
          type: string
      - description: Maximum page size is 100; default is 100.
        in: query
        name: page_size
        schema:
          format: int32
          type: integer
      - description: For multiple pages; must be specified in each request for two pages per sheet.
        in: query
        name: page_token
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1ListRetrievalContentExtractsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: List Retrieval Content Extracts
      tags:
      - Content Service
      description: List of retrieval extracts by content ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}/subjects:
    get:
      operationId: ContentService_ListContentSubjects
      parameters:
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - description: Maximum page size is 100; default is 100.
        in: query
        name: page_size
        schema:
          format: int32
          type: integer
      - description: IFor multiple pages; must be specified in each request for two pages per sheet.
        in: query
        name: page_token
        schema:
          type: string
      - description: Sort order for multi page requests; valid options are rank, rank desc, create_time, create_time desc.
        in: query
        name: order_by
        schema:
          type: string
      - description: Unique identifier for the grouping of specific topics.
        in: query
        name: subject_category_id
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1ListSubjectsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: List Content Subjects
      tags:
      - Content Service
      description: List subjects associated with a content item.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}/summary:
    get:
      operationId: ContentService_GetSummary
      parameters:
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetSummaryResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Get Summary
      tags:
      - Content Service
      description: Get summary information by content ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/contents/{content_id}:cascade:
    delete:
      operationId: ContentService_CascadeDeleteContent
      parameters:
      - description: Unique identifier for the content to be deleted.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Cascade Delete Content
      tags:
      - Content Service
      description: Delete the content and all child resources, and remove from all content groups.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/knowledge/v1alpha1/domains/{knowledge_domain_id}/contents/{content_id}/metadata:
    get:
      operationId: ContentService_GetContentMetadata
      parameters:
      - description: Unique identifier of the knowledge domain containing the requested metadata
        in: path
        name: knowledge_domain_id
        required: true
        schema:
          type: string
      - description: Unique identifier for the content within the matching content groups.
        in: path
        name: content_id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_v1alpha1GetContentMetadataResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filename_googlerpcStatus'
          description: An unexpected error response.
      summary: Get Content Metadata
      tags:
      - Content Service
      description: List metadata by content ID.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
components:
  schemas:
    filename_v1alpha1Content:
      properties:
        content_id:
          title: Unique identifier for the content within the matching content groups.
          type: string
        content_type_id:
          title: 'Required: ID of the ContentType for this Content'
          type: string
        source_location:
          title: String describing the location, typically a URI
          type: string
        display_name:
          title: Name of the collection.
          type: string
        description:
          title: Description of the content group.
          type: string
        status:
          $ref: '#/components/schemas/filename_v1alpha1ContentStatus'
        source_owner:
          title: Unique identifier for the owner of the source content owner.
          type: string
        revision:
          description: Specific revision being referenced; if not specified, the latest revision at the time of ingestion is used.
          type: string
        status_reason:
          description: Reason the content transitioned to current status value; only relevant for INGESTION_FAILED.
          type: string
        labels:
          additionalProperties:
            type: string
          description: Content key/value pair labels that identify characteristics of the content.
          type: object
      type: object
    filename_ContentExtractReadPermission:
      properties:
        allow_emails:
          description: A list of emails that have read permission for the content.
          items:
            type: string
          type: array
        allow_group_ids:
          description: 'A list of group ids that have read permission for the content. This will

            be different for each remote API. It does not need to follow any preset

            pattern, but should be consistent across the particular remote API.'
          items:
            type: string
          type: array
        deny_emails:
          description: A list of emails that do not have read permission for the content.
          items:
            type: string
          type: array
        deny_group_ids:
          description: "A list of group ids that have read permission for the content. This will\n // be different for each remote API. It does not need to follow any preset\n // pattern, but should be consistent across the particular remote API."
          items:
            type: string
          type: array
        any_required_group_ids:
          description: 'A list of group ids where a user needs to a part of AT LEAST ONE of them in order to access the content.

            Even if a user exists in one of these groups, ''read'' permission could still be restricted.'
          items:
            type: string
          type: array
        all_required_group_ids:
          description: 'A list group ids where a user needs to be a part of ALL of them in order to access the object.

            Even if a user exists in all of these groups, ''read'' permission could still be restricted.'
          items:
            type: string
          type: array
        is_public:
          description: A flag to indi

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pryon/refs/heads/main/openapi/pryon-content-service-api-openapi.yml