Essential Resource

API Docs V1

Updated 31st Jul 2024 by Nex AI Team

We are migrating to V2 APIs.

Please contact us for urgent assistance.

/ping

GET

Ping

Responses

Successful Response

Status

200

Type

application/json

{}

/creations

GET

Create New Creation

Responses

Successful Response

Status

200

Type

application/json

{}

/creation/{creation_id}/metadata

GET

Get Creation Metadata

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

PUT

Edit Creation Title

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

title
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

creation_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/{creation_id}/content

GET

Get Creation Metadata

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

PUT

Edit Creation Content

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

state_vector
Required
Array of:
integer
content
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

creation_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation

POST

Create New Creation

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

creation_id
Required
string

/creation/{creation_id}/title

PUT

Edit Creation Title

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

title
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

creation_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/{creation_id}

DELETE

Delete Creation

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

deleted_creation_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/{creation_id}/collaborator

PUT

Add Creation Collaborator

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

email
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

creation_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/{creation_id}/collaborators

GET

List All Collaborators

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Responses

Successful Response

Status

200

Type

application/json

Array of:

Object that contains the properties:

user_id
Required
string
username
Required
string
email
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/{creation_id}/collaborator/{collaborator_id}

DELETE

Delete Collaborator

Parameters

Creation Id

string

creation_id is required.

Remember to include it in the path.

Collaborator Id

string

collaborator_id is required.

Remember to include it in the path.

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

creation_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/from-markdown

POST

Create New Creation

Request Body

Type

application/json

Object that contains the properties:

content
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/creation/from-docx

POST

Create New Creation

Request Body

Type

multipart/form-data

Object that contains the properties:

file
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/context

POST

Chat

Request Body

Type

application/json

Object that contains the properties:

all
Any of the following:
boolean
null
search
Any of the following:
boolean
null
modules
Required
Array of:
string
prompt
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/collaborator

PUT

Create Collaborator

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

email
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/collaborator/{collaborator_id}

DELETE

Delete Collaborator

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Collaborator Id

string

collaborator_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/collaborators

GET

List Collaborator

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/integrations

GET

List Integrations

Responses

Successful Response

Status

200

Type

application/json

Array of:

Object that contains the properties:

integration_id
Required
string
type
Required
string
profile
Required
object
modules_count
Required
integer
last_used_at
Any of the following:
string
null

/integration/{integration_id}/validity

GET

List Integrations

Parameters

Integration Id

string

integration_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/integration/google/{integration_id}

PUT

Edit Google Account Integration

Parameters

Integration Id

string

integration_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

access_token
Required
string
refresh_token
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/google-drive

POST

Create Google Drive Module

Request Body

Type

application/json

Object that contains the properties:

integration_id
Required
string
folder_id
Required
string
parent_id
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/gmail

POST

Create Gmail Module

Request Body

Type

application/json

Object that contains the properties:

integration_id
Required
string
name
Required
string
label
Required
string
parent_id
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/integration/google

POST

Integrate Google Account

Request Body

Type

application/json

Object that contains the properties:

access_token
Required
string
refresh_token
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module

POST

Create Module

Request Body

Type

multipart/form-data

Object that contains the properties:

name
Required
string
file
Any of the following:
string
null
parent_id
Any of the following:
string
null
is_structured
Required
string
description
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/index

PUT

Edit Module Metadata

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/modules

POST

Create Module

Request Body

Type

multipart/form-data

Object that contains the properties:

files
Required
Array of:
string
parent_id
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

GET

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}

DELETE

Delete Module

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/parent

PUT

Edit Module Metadata

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

parent_id
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/metadata

PUT

Edit Module Metadata

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
description
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

GET

Get Module Metadata

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/text

POST

Create Module

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
text
Required
string
description
Any of the following:
string
null
parent_id
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/url

POST

Create Module

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
url
Required
string
parent_id
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/db

POST

Create Module

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
description
Required
string
db_schema
Required
Array of:
Object that contains the properties:
- column_name
  Required
  string
- description
  Required
  string
- type
  Required
  string
- choices
  Any of the following:
  Array of:
  string
  null
attached_module_id
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/collection

POST

Create Module

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
description
Required
string
parent_id
Any of the following:
string
null
priority
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/prompt

POST

Create Prompt Module

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
prompt
Required
string
description
Required
string
parent_id
Any of the following:
string
null

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/prompt

PUT

Create Prompt Module

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
prompt
Required
string
description
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/db

GET

Get Database Module

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Query

string

query is required.

Remember to include it in the query.

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

headers
Required
Array of:
string
rows
Required
Array of:
Array of:
```
{}
```

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/content

GET

Get Module

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/modules/updates

GET

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/labels

GET

Get Module Metadata

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/prompts

GET

Get Module Metadata

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/context

GET

Get Collection

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

Query

string

query is required.

Remember to include it in the query.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/module/{module_id}/json

GET

Get Collection

Parameters

Module Id

string

module_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/profile/password-reset/request

POST

Get Password Reset Code

Request Body

Type

application/json

Object that contains the properties:

email
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

user_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/profile/username

PUT

Edit Username

Request Body

Type

application/json

Object that contains the properties:

username
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

user_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/profile/picture

PUT

Edit Profile Picture

Request Body

Type

multipart/form-data

Object that contains the properties:

picture
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

user_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/profile/password-reset

POST

Reset Password

Request Body

Type

application/json

Object that contains the properties:

email
Required
string
reset_code
Required
string
new_password
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

user_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/profile

GET

Get Profile

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

profile_id
Required
string
username
Required
string
email
Any of the following:
string
null
picture_url
Required
string
role
Required
string
used_storage
Required
integer
max_storage
Required
integer
subscription
Required
string
organisation_id
Required
Any of the following:
string
null
organisation_name
Required
Any of the following:
string
null
joined_at
Required
string
tokens_remaining
Required
integer
redact_pii
Required
boolean

/user

POST

Create User

Request Body

Type

application/json

Object that contains the properties:

email
Any of the following:
string
null
username
Required
string
role
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

user_id
Required
string
api_key
Any of the following:
string
null

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/organisation

POST

Create Organisation

Request Body

Type

application/json

Object that contains the properties:

organisation_name
Required
string
root_email
Required
string
root_username
Required
string
root_password
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

pending_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/users

GET

Get Profile

Responses

Successful Response

Status

200

Type

application/json

Array of:

Object that contains the properties:

profile_id
Required
string
username
Required
string
email
Any of the following:
string
null
picture_url
Required
string
role
Required
string
used_storage
Required
integer
max_storage
Required
integer
subscription
Required
string
organisation_id
Required
Any of the following:
string
null
organisation_name
Required
Any of the following:
string
null
joined_at
Required
string

/user/{user_id}/role

PUT

Get Profile

Parameters

User Id

string

user_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

role
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/profile/pii-redaction

GET

Edit Pii Redaction

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

redact_pii
Required
boolean

PUT

Edit Pii Redaction

Request Body

Type

application/json

Object that contains the properties:

redact_pii
Required
boolean

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

redact_pii
Required
boolean

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/v2/files

POST

Create Files

Request Body

Type

application/json

Object that contains the properties:

files
Required
Array of:
Object that contains the properties:
- name
  Required
  string

Responses

Successful Response

Status

200

Type

application/json

Array of:

Object that contains the properties:

file_id
Required
string
name
Required
string
upload_url
Required
string
created_at
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/v2/collection

POST

Create Collection

Request Body

Type

application/json

Object that contains the properties:

name
Required
string
description
Required
string
columns
Required
Array of:
Object that contains the properties:
- name
  Required
  string
- description
  Any of the following:
  string
  null
- type
  Required
  string
- extractor_id
  Required
  string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

collection_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/v2/collections

GET

List Collections

Responses

Successful Response

Status

200

Type

application/json

Array of:

Object that contains the properties:

collection_id
Required
string
name
Required
string
description
Any of the following:
string
null
created_on
Required
string
modified_on
Required
string
collaborator_count
Required
integer

/chat-groups

GET

List Chat Groups

Responses

Successful Response

Status

200

Type

application/json

{}

/chats

GET

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/chat-group

POST

Create Chat Group

Request Body

Type

application/json

Object that contains the properties:

name
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/chat-group/{group_id}/chat

POST

Attach Chat To Chat Group

Parameters

Group Id

string

group_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

session_id
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/nql

POST

Chat

Request Body

Type

application/json

Object that contains the properties:

query
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/chat-group/{group_id}

DELETE

Delete Chat Group

Parameters

Group Id

string

group_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/chat-group/{group_id}/collaborator

PUT

Attach Chat To Chat Group

Parameters

Group Id

string

group_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

email
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/chat-group/{group_id}/collaborators

GET

List Chat Group Collaborators

Parameters

Group Id

string

group_id is required.

Remember to include it in the path.

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/infinicontext

POST

Chat

Request Body

Type

application/json

Object that contains the properties:

all
Any of the following:
boolean
null
modules
Required
Array of:
string
prompt
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/context/v2

POST

Get Context

Request Body

Type

application/json

Object that contains the properties:

modules
Required
Array of:
string
prompt
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/context/v2/function

POST

Get Context

Request Body

Type

application/json

Object that contains the properties:

type
Required
string
id
Required
string
data
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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/v2/collection/{collection_id}/rows

POST

Create Rows

Parameters

Collection Id

string

collection_id is required.

Remember to include it in the path.

Request Body

Type

application/json

Object that contains the properties:

type
Required
string
file_ids
Any of the following:
Array of:
string
null
texts
Any of the following:
Array of:
string
null

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

row_ids
Required
Array of:
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

GET

List Rows

Parameters

Collection Id

string

collection_id is required.

Remember to include it in the path.

Responses

Successful Response

Status

200

Type

application/json

Array of:

Object that contains the properties:

row_id
Required
string
name
Required
string
description
Any of the following:
string
null
row_data
Required
object
created_at
Required
string
modified_at
Required
string
status
Required
string
stage
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/search

GET

List Chats

Parameters

string

q is required.

Remember to include it in the query.

Instant

boolean

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/auth/sign-up

POST

Request Body

Type

application/json

Object that contains the properties:

email
Required
string
referrer
Required
Any of the following:
string
null
username
Required
string
password
Required
string

Responses

Successful Response

Status

200

Type

application/json

Object that contains the properties:

pending_id
Required
string

Validation Error

Status

422

Type

application/json

Object that contains the properties:

detail
Array of:
Object that contains the properties:
- loc
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

/auth/verify

POST

Verify

Request Body

Type

application/json

Object that contains the properties:

pending_id
Required
string
otp
Required
string

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
  Required
  Array of:
  Any of the following:
  string
  integer
- msg
  Required
  string
- type
  Required
  string

API Docs V1

Updated 31st Jul 2024 by Nex AI Team

We are migrating to V2 APIs.

/ping

Responses

/creations

Responses

/creation/{creation_id}/metadata

Parameters

creation_id is required.

Responses

Object that contains the properties:

Array of:

Object that contains the properties:

Array of:

Any of the following:

Parameters

creation_id is required.

Request Body

Object that contains the properties:

Responses

Object that contains the properties:

Object that contains the properties:

Array of:

Object that contains the properties:

Array of:

Any of the following:

/creation/{creation_id}/content

Parameters

creation_id is required.

Responses

Object that contains the properties:

Array of:

Object that contains the properties:

Array of:

Any of the following:

Parameters

creation_id is required.

Request Body

Object that contains the properties:

Array of:

Responses

Object that contains the properties:

Object that contains the properties:

Array of:

Object that contains the properties:

Array of:

Any of the following:

/creation

Responses

Object that contains the properties:

/creation/{creation_id}/title

Parameters

creation_id is required.

Request Body

Object that contains the properties:

Responses

Object that contains the properties:

Object that contains the properties:

Array of:

Object that contains the properties:

Array of:

Any of the following:

/creation/{creation_id}

Parameters

creation_id is required.

Responses

Object that contains the properties:

Object that contains the properties:

Array of:

Object that contains the properties:

Array of:

Any of the following:

/creation/{creation_id}/collaborator

Parameters

creation_id is required.

Request Body

Object that contains the properties:

Responses

Object that contains the properties: