Skip to main content
GET
/
retrieve
Retrieve relevant passages from ingested documents
curl --request GET \
  --url https://api.artosai.com/retrieve \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "url": "<string>",
      "snippet": "<string>",
      "score": 123,
      "document_title": "<string>",
      "document_type": "<string>",
      "file_synopsis": "<string>"
    }
  ],
  "query": "<string>",
  "search_type": "<string>",
  "total_results": 123,
  "processing_time_ms": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string
required

Search query or question.

sourceUrls
string

Comma‑separated list of S3 URLs to restrict the search.

topK
integer

Number of results to return.

Required range: x >= 1
search_type
enum<string>

Search method to employ.

Available options:
hybrid,
vector,
keyword

Response

200 - application/json

Search results

results
object[]
query
string
search_type
string
total_results
integer
processing_time_ms
integer