Endpoint Examples
Query Resource
This endpoint allows the user to make an HTTP POST request to submit a query to the specified collection.
Request Body
-
collection_id
(text): The ID of the collection to which the query is being submitted. -
request_query
(text): The query being submitted to the collection. -
json_schema
(text): The JSON schema for the query response. -
json_schema_rules
(text): Rules for the JSON schema.
Response
The response for this request is a JSON schema with the following structure:
-
response
(object): The JSON schema for the query response. -
tokens
(number): The number of tokens. -
success
(boolean): Indicates whether the request was successful.
POST
Authorizations
Body
multipart/form-data
Response
200
application/json
OK
The response is of type object
.