Suche Dokument

1 min

POST

https://api.archbee.com/api/public-api/docs/search

Search Archbee documents in docSpace. Can perform one of the 3 types of search:

ai-chat to return ai generative answer accompanied by source docs;
ai-retrieval to return just similar docs with the query;
words to perform normal search aka. "word-based"; use empty query to return all docs
single-doc to return document info by id

Header Parameters

Content-Typestringrequired
Example
application/json

Body Parameters

bodyobjectrequired
- querystringrequired
  Description
  Filter text, question or document title
- searchOnlyTitleboolean
  Description
  OPTIONAL. Search only by title
- persistSearchboolean
  Description
  OPTIONAL. Wether to keep a SearchSession in our database and return its id.
- searchSessionIdstring
  Description
  OPTIONAL. id for the SearchSession object to update. More useful for AI chat.
- docIdstring
  Example
  21-character__string0
  Description
  OPTIONAL. Return only one document with this id, if there is one
- dataTextFormatstring<markdown | html>
  Description
  OPTIONAL. Return documents with dataText in this format
  Allowed
  markdownhtml
- parentDocIdstring
  Example
  21-character__string0
  Description
  OPTIONAL. Return only child documents of the doc with this id, if there are any. Can be "null" for retrieving the root docs.
- typestring<words | ai-chat | ai-retrieval>
  Description
  OPTIONAL. which type of search to use; default is word-based
  Allowed
  wordsai-chatai-retrieval

Responses

200Process status

object
Description
Process status
- statusstring<OK>
  Description
  Response Status
  Allowed
  OK
- dataobject
  Description
  Response Data
  - searchSessionIdstring
    Description
    Search session id, can be used as input for next search calls.
  - docsDocResponse[]
    Description
    Array of Doc responses
    - idstring
      Description
      Archbee id, used for private access
    - namestring
      Description
      name of document
    - urlKeystring
      Description
      url of public document, used for public access (if published)
    - urlAliasstring
      Description
      In case you are migrating from another platform and you’d like to get a redirecting url to your current url, you can use this url path.
    - hiddenboolean
      Description
      indicates if document is hidden
    - privacystring<private | shared with team | public-via-link | public>
      Description
      describes how to access the document via public url (if published)
      Allowed
      privateshared with teampublic-via-linkpublic
    - highlightobject
      Description
      text from document, similar with query (word-based search only)

400Invalid request

Response400
- statusstring<OK | Not OK>
  Example
  Not OK
  Description
  Response Status
  Allowed
  OKNot OK
- messagesstring[]
  Example
```
[
  "Some error message"
]
```
  Description
  Array of messages

curl

curl --request POST \
     --url https://api.archbee.com/api/public-api/docs/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "query": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "query": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.archbee.com/api/public-api/docs/search", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.archbee.com/api/public-api/docs/search")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "query": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.archbee.com/api/public-api/docs/search"

payload = json.dumps({
   "query": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Process status
{
  "status": "",
  "data": {
    "searchSessionId": "",
    "docs": [
      {
        "id": "",
        "name": "",
        "urlKey": "",
        "urlAlias": "",
        "hidden": false,
        "privacy": "",
        "highlight": {}
      }
    ]
  }
}

400

// Invalid request
{
  "status": "Not OK",
  "messages": [
    "Some error message"
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.