CometAI API - Endpoints Deep Dive

N/A 

200: List of available models and CometAI’s set default, cheapest, and advanced models. 
Content: application/json 
    models (list of model objects) 
    default (object) 
    cheapest (object) 
    advanced (object) 

Example Body 

Example Response 

N/A 

{ 

  "success": true, 

  "data": { 

    "models": [ 

      {"id": "gpt-4o-mini", 

        "name": "GPT-4o-mini", 

        "description": "Consider it for its ability to output longer responses and deliver rapid replies with advanced comprehension. GPT-4o Mini is OpenAI’s most cost-efficient small model. Trained on information available through October 2023.", 

        "inputContextWindow": 128000, 

        "outputTokenLimit": 16384, 

        "supportsImages": true, 

        "provider": "Azure", 

        “supportsSystemPrompts”:true,  

        “systemPrompt”: “Additional prompt” 

      }], 

    "default”: <model Object>, 

    "advanced<model Object>, 

    "cheapest": <model Object> } 

} 

temperature (number) 
max_tokens (integer) 
dataSources (array of strings) 
    - strings represent the data source Ids. Obtain data source ids in the following ways: 

1. Call the /files/query endpoint.  

2. Upload a new data source using the /files/upload endpoint, the id is returned as the key attribute. 

messages (array of objects): 
     - role (string): Required. 

       Options include: 

        -  system 

        - assistant 

        - user. 
    - content (string): Required. 
type (string): Options include prompt. 
options (object): 
  - dataSourceOptions (object) 
  - ragOnly (boolean) 
  - skipRag (boolean) 
  - assistantId (string) 
  - model (object) Required. To get model Ids, make a request to the /available_models endpoint: 
       - id (string) 
  - prompt (string) 

200: Chat stream response. 
Content: application/json 

   success (boolean) 

   message (string) 
    data (string) 
400: Bad request, invalid or missing fields. 
401: Unauthorized, invalid authentication credentials. 
403: Forbidden, request refused. 
404: Not found, resource not found. 

Example Body 

Example Response 

{ 
     "data":{ 
         "temperature": 0.7, 
         "max_tokens": 4000, 
         "dataSources": [“netid@utdallas.edu/l80.json” 
or 
“netid@utdallas.edu/date/l80.json], 
         "messages": [ 
             { 
             "role": "user", 
             "content": "What is the mascot of UT Dallas?" 
             } 
         ], 
         "options": { 
             "ragOnly": false, 
             "skipRag": true, 
             "model": {“id”: "gpt-4o"}, 
             "prompt": "What is the capital of France?", 
           “assistantId”:”astp/abcdefghi” 
         } 
     } 
} 

{ 
     "success": true, 
     "message": "Chat completed successfully", 
     "data": "The mascot of UT Dallas is Temoc." 
} 

name (string): Required.  

   Options include: 

   - saveAsData 

   - createChunks 

   - ingestRag 

   - makeDownloadable 

   - extractText 
params (object) 
type (string): Required. 
name (string): Required. 
knowledgeBase (string): Required. 
tags (array of strings): Required. 
data (object): Required. 

200: File upload process initiated or completed successfully. 
Content: application/json 
    success (boolean) 
    uploadUrl (string, nullable) 
    statusUrl (string, nullable) 
    contentUrl (string, nullable) 
    metadataUrl (string, nullable) 
    key (string, nullable) 
400: Bad request, incorrect or missing parameters. 
401: User does not have access to the file upload functionality. 

Example Body 

Example Response 

{ 
     "data":{ 
         "type": "application/fileExtension", 
         "name": "fileName.pdf", 
         "knowledgeBase": "default", 
         "tags": [], 
         "data": {} 

}} 

{ 
     "success": true, 
     "uploadUrl": "<uploadUrl>", 
     "statusUrl": "<statusUrl>", 
     "contentUrl": "<contentUrl>", 
     "metadataUrl": "<metadataUrl>", 
     "key": "netid@utdallas.edu/date/293088.json" 
} 

startDate (string, date-time):   

   Default is 2021-01-01T00:00:00Z. 
pageSize (integer):  

   Default is 10. 
pageKey (object): 
  - id (string) 
  - createdAt (string) 
  - type (string) 
namePrefix (string or null) 

createdAtPrefix (string or null) 
typePrefix (string or null) 
types (array of strings):    

   Default is an empty array. 
tags (array of strings):  

   Default is an empty array. 
pageIndex (integer):  

   Default is 0. 
forwardScan (boolean):  

   Default is false. 
sortIndex (string):  

   Default is createdAt. 

200: Returns a list of files that match the query criteria. 
Content: application/json 
     success (boolean) 
     data (object) 
     items (array of objects) 
     pageKey (object): Key to retrieve the next page of results 

Example Body 

Example Response 

{ 
     "data":{ 
         "pageSize": 2, 
         "sortIndex": "", 
         "forwardScan": false 
         } 
} 

{ 
     "success": true, 
     "data": { 
         "items": [ 
             { 
                 "createdAt": "2024-07-15T17:12:45.046682", 
                 "updatedBy": "netid@utdallas.edu", 
                 "createdBy": "netid@utdallas.edu", 
                 "name": "fileName.doc", 
                 "knowledgeBase": "default", 
                 "data": {}, 
                 "updatedAt": "2024-07-15T17:12:45.046700", 
                 "totalTokens": 12644, 
                 "dochash": "25ef6a3e472d8dbe501915c1", 
                 "id":     

                "netid@utdallas.edu/date/2389020943.json", 
                 "tags": [], 
                 "totalItems": 1025, 
                 "type": "application/fileExtension" 
             } ] } } 

N/A 

200: A list of tags. 
Content: application/json 
     success (boolean) 
     data (object) 
     tags (array of strings) 

Example Body 

Example Response 

N/A 

{ 
     "success": true, 
     "data": { 
         "tags": [ 
             "NewTag" 
         ]}} 

tags (array of strings): Default is an empty array. 

200: Result of tag creation. 
Content: application/json 
     success (boolean) 
     message (string) 

Example Body 

Example Response 

{ 
     "data": { 
         "tags": ["NewTag"] 
     } 
} 

{ 
     "success": true, 
     "message": "Tags added successfully" 
} 

tag (string): Required. 

200: Result of tag deletion. 
Content: application/json 
    success (boolean) 
    message (string) 

Example Body 

Example Response 

{ 
     "data":{ 
         "tag": "NewTag" 
     } 
} 

{ 
     "success": true, 
     "message": "Tag deleted successfully" 
} 

id (string): Required. 
tags (array of strings): Default is an empty array. 

200: Result of setting file tags. 
Content: application/json 
     success (boolean) 
     message (string) 

Example Body 

Example Response 

{ 
     "data":{ 
         "id": "netid@utdallas.edu/date/290208.json", 
         "tags": ["NewTag"] 
     } 
} 

{ 
     "success": true, 
     "message": "Tags updated and added to user" 
} 

N/A 

200: List of assistants retrieved successfully. 
Content: application/json 
    success (boolean) 
    message (string) 
     data (array) 

Example Body 

Example Response 

N/A 

{ 
   "success": true, 
   "message": "Assistants retrieved successfully", 
   "data": [ 
     { 
       "assistantId": "astp/498370528-38594", 
       "version": 3, 
       "instructions": "<instructions>", 
       "disclaimerHash": "348529340098580234959824580-pueiorupo4", 
       "coreHash": "eiouqent84832n8989pdeer", 
       "user": "netid@utdallas.edu", 
       "uri": null, 
       "createdAt": "2024-07-15T19:07:57", 
       "dataSources": [ 
         { 
           "metadata": "<metadata>", 
           "data": "", 
           "name": "api_documentation.yml", 
           "raw": "", 
           "id": "global/7834905723785897982345088927.content.json", 
           "type": "application/x-yaml", 
...<More Data>... 

assistantId (string): Required. 
recipientUsers (array of strings): Required. 
note (string) 

200: Assistant sharing response. 
Content: application/json 
    success (boolean) 
    message (string) 

Example Body 

Example Response 

{ 
     "data":{ 
         "assistantId": "ast/8934572093982034020-9", 
         "recipientUsers": ["netid@utdallas.edu"], 
         "note": "check this out!" 
     } 
} 

{ 
     "success": false, 
     "message": "Unable to share with some users", 
     "failedShares": [ 
         "netid@utdallas.edu" 
     ] 
} 

name (string): Required. 
description (string): Required. 
assistantId (string):  

    Needed if updating an existing assistant.  

   We will provide you with one if creating a new assistant 
tags (array of strings): Required. 
instructions (string): Required. 
disclaimer (string) 
uri (string or null) 
dataSources (array of objects): Required. 
  - Entire Data Source object 
dataSourceOptions (array of objects): 
  - insertAttachedDocumentsMetadata (boolean)  

    Includes Attached Data Source Metadata in Prompt 
  - insertAttachedDocuments (boolean)  

    Includes Attached Documents in Prompt 
  - insertConversationDocuments (boolean) 

    Includes Conversation Documents in Prompt 
  - disableDataSources (boolean)  

    Disable Data Source Insertion 
  - insertConversationDocumentsMetadata (boolean)  

    Include Conversation Data Source Metadata in Prompt 
  - ragConversationDocuments (boolean) 

    Include Conversation Documents in RAG 
  - ragAttachedDocuments (boolean)  

    Include Attached Documents in RAG 

200: Assistant creation response. 
Content: application/json 
    success (boolean) 
    message (string) 
    data (object) 

Example Body 

Example Response 

{ 
     "data": { 
         "name": "Sample Assistant 3", 
         "description": "This is a sample assistant for demonstration purposes", 
         "assistantId": "", 
         "tags": ["test"], 
         "instructions": "Respond to user queries about general knowledge topics", 
         "disclaimer": "This assistant's responses are for informational purposes only", 
         "dataSources": [{'id': 'e48759073324384kjsf', 'name': 'api_paths_summary.csv', 'type': 'text/csv', 'raw': '', 'data': '', 'key': 'netid@utdallas.edu/date/w3ou009we3.json ', 'metadata': {'name': 'api_paths_summary.csv', 'totalItems': 20, 'locationProperties': ['row_number'], 'contentKey': 'netid@utdallas.edu/date/w3ou009we3.json.content.json', 'createdAt': '2024-07-15T18:58:24.912235', 'totalTokens': 3750, 'tags': [], 'props': {}}}], 
         "tools": [] 
     } 
} 

{ 
     "success": true, 
     "message": "Assistant created successfully", 
     "data": { 
         "assistantId": "astp/3io4u5ipy34jkelkdfweiorwur", 
         "id": "ast/03uio3904583049859482", 
         "version": 1 
     } 
} 

assistantId (string): Required. 

200: Assistant deletion response. 
Content: application/json 
    success (boolean) 
    message (string) 

Example Body 

Example Response 

{ 
     "data":{ 
         "assistantId": "astp/3209457834985793094" 
     } 
} 

{ 
     "success": true, 
     "message": "Assistant deleted successfully." 
}