Get semantic reference suggestions | Documentation

curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/semantic/reference-suggestions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "filter": {
    "entityType": "Entry",
    "contentTypeIds": [
      "string"
    ]
  },
  "referenceFieldId": "string",
  "entityId": "string"
}'

{
  "sys": {
    "type": "Array"
  },
  "items": [
    {
      "sys": {
        "type": "SemanticReferenceSuggestionsResult",
        "entity": {
          "sys": {
            "type": "Link",
            "linkType": "Entry",
            "id": "myEntry"
          }
        },
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "mySpace"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "master"
          }
        }
      }
    }
  ]
}

This endpoint returns suggested entries that you can reference in a given field based on semantic relevance.

Authentication

AuthorizationBearer

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

Path parameters

space_idstringRequired

ID of the space in form of a string

environment_idstringRequired

ID of the environment in form of a string

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful

1	{
2	"sys": {
3	"type": "Array"
4	},
5	"items": [
6	{
7	"sys": {
8	"type": "SemanticReferenceSuggestionsResult",
9	"entity": {
10	"sys": {
11	"type": "Link",
12	"linkType": "Entry",
13	"id": "myEntry"
14	}
15	},
16	"space": {
17	"sys": {
18	"type": "Link",
19	"linkType": "Space",
20	"id": "mySpace"
21	}
22	},
23	"environment": {
24	"sys": {
25	"type": "Link",
26	"linkType": "Environment",
27	"id": "master"
28	}
29	}
30	}
31	}
32	]
33	}