Search across accessible Spaces

Search documentation across the Spaces accessible to your account.

{
    "title": "Search across accessible Spaces",
    "description": "",
    "method": "POST",
    "baseUrl": "https://app.docuwriter.ai",
    "endpoint": "/api/search",
    "headers": [
        {
            "key": "Authorization",
            "value": "Bearer YOUR_API_TOKEN",
            "type": "string",
            "required": true
        },
        {
            "key": "Accept",
            "value": "application/json",
            "type": "string",
            "required": true
        },
        {
            "key": "Content-Type",
            "value": "application/json",
            "type": "string",
            "required": true
        }
    ],
    "queryParams": [],
    "pathParams": [],
    "bodyType": "json",
    "requestBody": "{\n  \"query\": \"deployment requirements\",\n  \"per_page\": 10\n}",
    "formData": [],
    "rawBody": "",
    "responses": {
        "200": {
            "description": "HTTP 200: success: true, data.results, total, query, indexing_spaces. Results include id, space_id, space_name, item_type, title, hierarchy, url, snippet, score. indexing_spaces lists unindexed Spaces by id and name. Illustrative JSON example; sample values are fictional. Some optional or additional resource fields may be omitted.",
            "body": "{\n  \"success\": true,\n  \"data\": {\n    \"results\": [],\n    \"total\": 0,\n    \"query\": \"payment lifecycle\",\n    \"indexing_spaces\": []\n  }\n}"
        },
        "401": {
            "description": "Missing or invalid account API token.Missing or invalid account API token. Example JSON response.",
            "body": "{\n  \"message\": \"Unauthenticated.\"\n}"
        }
    }
}

Request fields

Usage notes

• No accessible Spaces returns an empty successful result.
• This request can initiate indexing for unindexed Spaces, so an empty result may change later.
• 422 for invalid input; 500 for search failures.
• Use Search a Space to restrict retrieval.

API authentication.