API Reference

Answer a question

post
https://api.instill-ai.com/v1alpha/namespaces//catalogs//ask

Provides the response to the prompted question, returning contextual information like the chunks used to build the answer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the namespace owning the catalog.

string
required

ID of the catalog.

Body Params
string

Text prompt with the question.

int32

Top K. Default value: 5.

fileUids
array of strings

File UIDs. When this field is provided, the response will only use the specified files to build the answer. The UIDs must be UUID-formatted strings.

fileUids
Headers
string

Indicates the authenticated namespace is making the request on behalf of another entity, typically an organization they belong to

Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago