Actions (45)
Documents · 14
- Bulk Create DocumentsPOST /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/bulk_create
Bulk create documents within a DocumentType.
documented - Bulk Create or Update (Verbose)POST /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/bulk_create_or_update_verbose
Bulk create or update documents with verbose results.
documented - Bulk Destroy DocumentsPOST /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/bulk_destroy
Bulk delete documents within a DocumentType.
documented - Bulk Update DocumentsPUT /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/bulk_update
Bulk update documents within a DocumentType.
documented - Create DocumentPOST /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents.json
Create a new document in a DocumentType.
documented - Create or update documentsPOST /api/as/v1/engines/{ENGINE_NAME}/documents
Index (create or update) documents for an Engine; documents are processed asynchronously.
documented - Delete DocumentDELETE /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/{DOCUMENT_ID}.json
Delete a document by external_id.
documented - Delete documentsDELETE /api/as/v1/engines/{ENGINE_NAME}/documents
Delete documents by id across the Engine.
documented - Get DocumentGET /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/{EXTERNAL_ID}.json
Get a specific document by external_id.
documented - Get documentsGET /api/as/v1/engines/{ENGINE_NAME}/documents
Retrieve documents by id (batch capability shown in docs).
documented - List DocumentsGET /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents.json
List documents within a DocumentType.
documented - List documentsGET /api/as/v1/engines/{ENGINE_NAME}/documents/list
List documents for an Engine (paginated).
documented - Partial update documentsPATCH /api/as/v1/engines/{ENGINE_NAME}/documents
Partially update specific fields on existing documents by id.
documented - Update Document FieldsPUT /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}/documents/{DOCUMENT_ID}/update_fields.json
Update fields for an existing document.
documented
Engines · 8
- Create Engine (Site Search)POST /api/v1/engines.json
Create a new API-based Site Search Engine.
documented - Create enginePOST /api/as/v1/engines
Create a new Engine.
documented - Delete Engine (Site Search)DELETE /api/v1/engines/{ENGINE_ID}.json
Delete a Site Search Engine.
documented - Delete engineDELETE /api/as/v1/engines/{ENGINE_NAME}
Delete an Engine by name.
documented - List Engines (Site Search)GET /api/v1/engines.json
List all Site Search engines.
documented - List enginesGET /api/as/v1/engines
List all App Search engines accessible to the API key.
documented - Retrieve Engine (Site Search)GET /api/v1/engines/{ENGINE_ID}.json
Get details for a specific Site Search Engine.
documented - Retrieve engineGET /api/as/v1/engines/{ENGINE_NAME}
Get details for a single Engine by name.
documented
Credentials · 6
- Create credentialPOST /api/as/v1/credentials
Create a new API key (_private/api/private/admin or public search key as per type)._
documented - Delete credentialDELETE /api/as/v1/credentials/{API_KEY_NAME}
Delete a credential by key name.
documented - List credentialsGET /api/as/v1/credentials
List all API keys and credentials.
documented - Read credentialGET /api/as/v1/credentials/{API_KEY_NAME}
Retrieve a single credential by key name.
documented - Retrieve a credentialGET /api/as/v1/credentials/{API_KEY_NAME}
Get a single credential by its key name.
documented - Update credentialPUT /api/as/v1/credentials/{API_KEY_NAME}
Update an existing API key's properties (e.g., name, read/write scope).
documented
Curations · 6
- Create curationsPOST /api/as/v1/engines/{ENGINE_NAME}/curations
Create new curations for the Engine.
documented - Delete curationsDELETE /api/as/v1/engines/{ENGINE_NAME}/curations
Delete curations for the Engine.
documented - List curationsGET /api/as/v1/engines/{ENGINE_NAME}/curations
List all curations for the Engine.
documented - List curations (global)GET /api/as/v1/curations
List curations at the account level (global scope).
documented - Retrieve a curationsGET /api/as/v1/engines/{ENGINE_NAME}/curations/{CURATION_ID}
Get a single curations by its id.
documented - Update curationsPATCH /api/as/v1/engines/{ENGINE_NAME}/curations
Update existing curations for the Engine.
documented
DocumentTypes · 4
- Add a DocumentTypePOST /api/v1/engines/{ENGINE_ID}/document_types.json
Add a DocumentType to an API-based Site Search Engine.
documented - Delete DocumentTypeDELETE /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}.json
Delete a DocumentType from a Site Search Engine.
documented - Get DocumentTypeGET /api/v1/engines/{ENGINE_ID}/document_types/{DOCUMENT_TYPE}.json
Get a specific DocumentType for a Site Search Engine.
documented - List DocumentTypesGET /api/v1/engines/{ENGINE_ID}/document_types.json
List all DocumentTypes for a Site Search Engine.
documented
Search · 4
- Multi-searchPOST /api/as/v1/engines/{ENGINE_NAME}/multi_search
Submit multiple search queries in a single call.
documented - Multi-search (GET)GET /api/as/v1/engines/{ENGINE_NAME}/multi_search
Retrieve results for a multi-search request.
documented - SearchPOST /api/as/v1/engines/{ENGINE_NAME}/search
Perform a search query against an Engine (POST).
documented - Search (GET)GET /api/as/v1/engines/{ENGINE_NAME}/search
Perform a search query against an Engine (GET).
documented