POST
/
create
curl --location 'https://document-query.pyqai.com/create' \
--header 'Authorization: ExampleToken' \
--form 'account_id="ExampleAccountId"' \
--form 'index_name="Example New Index Name"' \
--form 'document_source="Example 1"' \
--form 'input_sequence=@"example_file_path.txt"'
{
    "response": "Successfully created index"
}

Form Data

input_sequence
file
required

This is the initial document you want to upload to your new index. Currently supported file types are md, pdf, and txt.

document_source
string
required

This is the name of the document you wish to insert into your new index.

account_id
int
required

This is your account ID.

index_name
string

This is the name of the index you wish to create. This parameter is optional - if left blank will use auto indexing.

embeddings_model
string

This is an optional parameter, allowing you to specify the name of the embeddings model you’d like to use. “mpnet” is the default model and value, “instructor” will use the Instructor XL embedding model instead.

instruction
string

This is an optional parameter that is required when using “instructor” as your embedding model. This will be used as the instruction with with to embed your documents.

Headers

Authorization
string
required

This is your API token associated with your account.

Response

response
string

Indicates whether the call was successful.