API Docs V1
Updated 31st Jul 2024 by Nex AI Team
We are migrating to V2 APIs.
/ping
Ping
Responses
Successful Response
Status
200
Type
application/json
{}
/creations
Create New Creation
Responses
Successful Response
Status
200
Type
application/json
{}
/creation/{creation_id}/metadata
Get Creation Metadata
Parameters
Creation Id
creation_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
Edit Creation Title
Parameters
Creation Id
creation_id is required.
Request Body
Type
application/json
Object that contains the properties:
title
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
creation_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/{creation_id}/content
Get Creation Metadata
Parameters
Creation Id
creation_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
Edit Creation Content
Parameters
Creation Id
creation_id is required.
Request Body
Type
application/json
Object that contains the properties:
state_vector
RequiredArray of:
integercontent
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
creation_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation
Create New Creation
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
creation_id
Requiredstring
/creation/{creation_id}/title
Edit Creation Title
Parameters
Creation Id
creation_id is required.
Request Body
Type
application/json
Object that contains the properties:
title
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
creation_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/{creation_id}
Delete Creation
Parameters
Creation Id
creation_id is required.
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
deleted_creation_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/{creation_id}/collaborator
Add Creation Collaborator
Parameters
Creation Id
creation_id is required.
Request Body
Type
application/json
Object that contains the properties:
email
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
creation_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/{creation_id}/collaborators
List All Collaborators
Parameters
Creation Id
creation_id is required.
Responses
Successful Response
Status
200
Type
application/json
Array of:
Object that contains the properties:
user_id
Requiredstringusername
Requiredstringemail
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/{creation_id}/collaborator/{collaborator_id}
Delete Collaborator
Parameters
Creation Id
creation_id is required.
Collaborator Id
collaborator_id is required.
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
creation_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/from-markdown
Create New Creation
Request Body
Type
application/json
Object that contains the properties:
content
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/creation/from-docx
Create New Creation
Request Body
Type
multipart/form-data
Object that contains the properties:
file
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/context
Chat
Request Body
Type
application/json
Object that contains the properties:
all
Any of the following:
booleannullsearch
Any of the following:
booleannullmodules
RequiredArray of:
stringprompt
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/collaborator
Create Collaborator
Parameters
Module Id
module_id is required.
Request Body
Type
application/json
Object that contains the properties:
email
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/collaborator/{collaborator_id}
Delete Collaborator
Parameters
Module Id
module_id is required.
Collaborator Id
collaborator_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/collaborators
List Collaborator
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/integrations
List Integrations
Responses
Successful Response
Status
200
Type
application/json
Array of:
Object that contains the properties:
integration_id
Requiredstringtype
Requiredstringprofile
Requiredobjectmodules_count
Requiredintegerlast_used_at
Any of the following:
stringnull
/integration/{integration_id}/validity
List Integrations
Parameters
Integration Id
integration_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/integration/google/{integration_id}
Edit Google Account Integration
Parameters
Integration Id
integration_id is required.
Request Body
Type
application/json
Object that contains the properties:
access_token
Requiredstringrefresh_token
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/google-drive
Create Google Drive Module
Request Body
Type
application/json
Object that contains the properties:
integration_id
Requiredstringfolder_id
Requiredstringparent_id
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/gmail
Create Gmail Module
Request Body
Type
application/json
Object that contains the properties:
integration_id
Requiredstringname
Requiredstringlabel
Requiredstringparent_id
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/integration/google
Integrate Google Account
Request Body
Type
application/json
Object that contains the properties:
access_token
Requiredstringrefresh_token
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module
Create Module
Request Body
Type
multipart/form-data
Object that contains the properties:
name
Requiredstringfile
Any of the following:
stringnullparent_id
Any of the following:
stringnullis_structured
Requiredstringdescription
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/index
Edit Module Metadata
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/modules
Create Module
Request Body
Type
multipart/form-data
Object that contains the properties:
files
RequiredArray of:
stringparent_id
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
Create Module
Parameters
Parent Id
Shared
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}
Delete Module
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/parent
Edit Module Metadata
Parameters
Module Id
module_id is required.
Request Body
Type
application/json
Object that contains the properties:
parent_id
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/metadata
Edit Module Metadata
Parameters
Module Id
module_id is required.
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringdescription
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
Get Module Metadata
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/text
Create Module
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringtext
Requiredstringdescription
Any of the following:
stringnullparent_id
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/url
Create Module
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringurl
Requiredstringparent_id
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/db
Create Module
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringdescription
Requiredstringdb_schema
RequiredArray of:
Object that contains the properties:
column_name
Requiredstringdescription
Requiredstringtype
Requiredstringchoices
Any of the following:
Array of:
stringnull
attached_module_id
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/collection
Create Module
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringdescription
Requiredstringparent_id
Any of the following:
stringnullpriority
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/prompt
Create Prompt Module
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringprompt
Requiredstringdescription
Requiredstringparent_id
Any of the following:
stringnull
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/prompt
Create Prompt Module
Parameters
Module Id
module_id is required.
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringprompt
Requiredstringdescription
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/db
Get Database Module
Parameters
Module Id
module_id is required.
Query
query is required.
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
headers
RequiredArray of:
stringrows
RequiredArray of:
Array of:
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/content
Get Module
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/modules/updates
Stream Updates
Parameters
Parent Id
Shared
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/labels
Get Module Metadata
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/prompts
Get Module Metadata
Parameters
Module Id
module_id is required.
Q
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/context
Get Collection
Parameters
Module Id
module_id is required.
Query
query is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/module/{module_id}/json
Get Collection
Parameters
Module Id
module_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/profile/password-reset/request
Get Password Reset Code
Request Body
Type
application/json
Object that contains the properties:
email
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
user_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/profile/username
Edit Username
Request Body
Type
application/json
Object that contains the properties:
username
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
user_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/profile/picture
Edit Profile Picture
Request Body
Type
multipart/form-data
Object that contains the properties:
picture
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
user_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/profile/password-reset
Reset Password
Request Body
Type
application/json
Object that contains the properties:
email
Requiredstringreset_code
Requiredstringnew_password
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
user_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/profile
Get Profile
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
profile_id
Requiredstringusername
Requiredstringemail
Any of the following:
stringnullpicture_url
Requiredstringrole
Requiredstringused_storage
Requiredintegermax_storage
Requiredintegersubscription
Requiredstringorganisation_id
RequiredAny of the following:
stringnullorganisation_name
RequiredAny of the following:
stringnulljoined_at
Requiredstringtokens_remaining
Requiredintegerredact_pii
Requiredboolean
/user
Create User
Request Body
Type
application/json
Object that contains the properties:
email
Any of the following:
stringnullusername
Requiredstringrole
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
user_id
Requiredstringapi_key
Any of the following:
stringnull
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/organisation
Create Organisation
Request Body
Type
application/json
Object that contains the properties:
organisation_name
Requiredstringroot_email
Requiredstringroot_username
Requiredstringroot_password
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
pending_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/users
Get Profile
Responses
Successful Response
Status
200
Type
application/json
Array of:
Object that contains the properties:
profile_id
Requiredstringusername
Requiredstringemail
Any of the following:
stringnullpicture_url
Requiredstringrole
Requiredstringused_storage
Requiredintegermax_storage
Requiredintegersubscription
Requiredstringorganisation_id
RequiredAny of the following:
stringnullorganisation_name
RequiredAny of the following:
stringnulljoined_at
Requiredstring
/user/{user_id}/role
Get Profile
Parameters
User Id
user_id is required.
Request Body
Type
application/json
Object that contains the properties:
role
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/profile/pii-redaction
Edit Pii Redaction
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
redact_pii
Requiredboolean
Edit Pii Redaction
Request Body
Type
application/json
Object that contains the properties:
redact_pii
Requiredboolean
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
redact_pii
Requiredboolean
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/v2/files
Create Files
Request Body
Type
application/json
Object that contains the properties:
files
RequiredArray of:
Object that contains the properties:
name
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Array of:
Object that contains the properties:
file_id
Requiredstringname
Requiredstringupload_url
Requiredstringcreated_at
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/v2/collection
Create Collection
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstringdescription
Requiredstringcolumns
RequiredArray of:
Object that contains the properties:
name
Requiredstringdescription
Any of the following:
stringnulltype
Requiredstringextractor_id
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
collection_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/v2/collections
List Collections
Responses
Successful Response
Status
200
Type
application/json
Array of:
Object that contains the properties:
collection_id
Requiredstringname
Requiredstringdescription
Any of the following:
stringnullcreated_on
Requiredstringmodified_on
Requiredstringcollaborator_count
Requiredinteger
/chat-groups
List Chat Groups
Responses
Successful Response
Status
200
Type
application/json
{}
/chats
List Chats
Parameters
Group Id
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/chat-group
Create Chat Group
Request Body
Type
application/json
Object that contains the properties:
name
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/chat-group/{group_id}/chat
Attach Chat To Chat Group
Parameters
Group Id
group_id is required.
Request Body
Type
application/json
Object that contains the properties:
session_id
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/nql
Chat
Request Body
Type
application/json
Object that contains the properties:
query
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/chat-group/{group_id}
Delete Chat Group
Parameters
Group Id
group_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/chat-group/{group_id}/collaborator
Attach Chat To Chat Group
Parameters
Group Id
group_id is required.
Request Body
Type
application/json
Object that contains the properties:
email
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/chat-group/{group_id}/collaborators
List Chat Group Collaborators
Parameters
Group Id
group_id is required.
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/infinicontext
Chat
Request Body
Type
application/json
Object that contains the properties:
all
Any of the following:
booleannullmodules
RequiredArray of:
stringprompt
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/context/v2
Get Context
Request Body
Type
application/json
Object that contains the properties:
modules
RequiredArray of:
stringprompt
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/context/v2/function
Get Context
Request Body
Type
application/json
Object that contains the properties:
type
Requiredstringid
Requiredstringdata
Required{ "title": "Data" }
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/v2/collection/{collection_id}/rows
Create Rows
Parameters
Collection Id
collection_id is required.
Request Body
Type
application/json
Object that contains the properties:
type
Requiredstringfile_ids
Any of the following:
Array of:
stringnulltexts
Any of the following:
Array of:
stringnull
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
row_ids
RequiredArray of:
string
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
List Rows
Parameters
Collection Id
collection_id is required.
Responses
Successful Response
Status
200
Type
application/json
Array of:
Object that contains the properties:
row_id
Requiredstringname
Requiredstringdescription
Any of the following:
stringnullrow_data
Requiredobjectcreated_at
Requiredstringmodified_at
Requiredstringstatus
Requiredstringstage
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/search
List Chats
Parameters
Q
q is required.
Instant
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/auth/sign-up
Sign Up
Request Body
Type
application/json
Object that contains the properties:
email
Requiredstringreferrer
RequiredAny of the following:
stringnullusername
Requiredstringpassword
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
Object that contains the properties:
pending_id
Requiredstring
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring
/auth/verify
Verify
Request Body
Type
application/json
Object that contains the properties:
pending_id
Requiredstringotp
Requiredstring
Responses
Successful Response
Status
200
Type
application/json
{}
Validation Error
Status
422
Type
application/json
Object that contains the properties:
detail
Array of:
Object that contains the properties:
loc
RequiredArray of:
Any of the following:
stringintegermsg
Requiredstringtype
Requiredstring