search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso
App Search Documentation / app search: Schema
Schema

From Zero to Search

Guides

API Reference

App Search API Clients

Self-Managed App Search

Resources

Schema

Want to start with the core concepts? Give our Indexing Documents guide a read.


Alter the schema fields of your Engine.

Before you begin, familiarize yourself with the schema design principles within the API Overview.

Authentication

For authentication, the Schema endpoint requires...

  1. A Host Identifier: [HOST_IDENTIFIER]
  2. The name of your Engine: [ENGINE]
  3. A Private API Key: [PRIVATE_API_KEY]
curl -X GET 'https://[HOST_IDENTIFIER].api.swiftype.com/api/as/v1/engines/[ENGINE]/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [PRIVATE_API_KEY]'

List Schema

GET /api/as/v1/engines/{ENGINE_NAME}/schema
Example - A GET request to return the whole schema. 
curl -X GET 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
Example Response 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Example - A GET request to return the whole schema.
No Java example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
Example Response
No Java example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Example - A GET request to return the whole schema.
No Node example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
Example Response
No Node example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Example - A GET request to return the whole schema.
No Ruby example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
Example Response
No Ruby example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Example - A GET request to return the whole schema.
No Python example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
Example Response
No Python example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Example - A GET request to return the whole schema.
No Javascript example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
Example Response
No Javascript example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Update Schema

Adjusting your schema begins a reindex of your data.
Your schema can not be changed during a reindex.


When updating a Schema, you can either...

Updates an Existing Schema

POST /api/as/v1/engines/{ENGINE_NAME}/schema
Example - A POST request that changes the square_km field from number to text. 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'
Example Response 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Example - A POST request that changes the square_km field from number to text.
No Java example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'
Example Response
No Java example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Example - A POST request that changes the square_km field from number to text.
No Node example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'
Example Response
No Node example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Example - A POST request that changes the square_km field from number to text.
No Ruby example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'
Example Response
No Ruby example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Example - A POST request that changes the square_km field from number to text.
No Python example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'
Example Response
No Python example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Example - A POST request that changes the square_km field from number to text.
No Javascript example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'
Example Response
No Javascript example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Creates a new Schema Field

You may have up to 64 fields.

Fields cannot be named: external_id, engine_id, highlight, or, and, not, any, all, none.

Example - A POST request to add a new number field, square_mi. 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'
Example Response 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Example - A POST request to add a new number field, square_mi.
No Java example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'
Example Response
No Java example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Example - A POST request to add a new number field, square_mi.
No Node example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'
Example Response
No Node example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Example - A POST request to add a new number field, square_mi.
No Ruby example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'
Example Response
No Ruby example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Example - A POST request to add a new number field, square_mi.
No Python example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'
Example Response
No Python example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Example - A POST request to add a new number field, square_mi.
No Javascript example available, showing cURL 
curl -X POST 'https://host-2376rb.api.swiftype.com/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'
Example Response
No Javascript example available, showing cURL 
{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Errors

If one field fails validation then the entire set will fail.

Name indicates the name of the field. Type indicates the type of the field.

400 Error MessageSolution
"Type is not included in the list"The allowed types are: text, number, date, geolocation". Ensure that no spaces are included and only one of the four types is present. Watch out for integer, which will not work - expects number.
"Engine is reindexing."You may proceed with Schema changes once reindexing is complete. Time varies based on size of Engine.
"Name cannot contain whitespace"Can not contain any whitespace characters like 'my field'
"Name cannot have a leading underscore"Can not start with a leading underscore like '_myfield'.
"Name cannot contain more than 64 characters"Very long field names are not allowed.
"Name cannot be a reserved field (external_id, engine_id, highlight, or, and, not, any, all, none)"These field names are reserved for your safety :). For example, trying to define an 'all' filter for a field called 'all' would be very difficult to understand.
"Name can only contain lowercase letters, numbers, and underscores"No dashes, capitals, strange characters or other such silliness!
"Name must contain a lowercase letter"You can not have a field with only capital letters.
"Name must be unique"Each field name must be unique.

What's Next?

The Schema endpoint is how you adjust your foundational data model. Now that you know how to make Schema changes via the API, you may be interested in exploring deeper into Indexing Documents. Alternatively, you may be into some of the deeper analytics presented by Curations and Clickthrough.

Stuck? Looking for help? Contact support or check out the App Search community forum!