Create an article type

Create an article type. Article types are a shared, platform-managed catalog (not scoped to a single account) — creating one requires the elevated locations-directory:support scope, not the regular locations-directory:write scope used for per-account writes elsewhere in the Locations Directory APIs.

name must be unique (case-insensitive) across all article types.

When content_type is JSON, json_schema is required and is validated for compilability; articles of this type will later be validated against it.

ingestion_task_queue and ingestion_workflow_name route an optional async content-ingestion workflow (Temporal) for this type. They must either both be provided, or both be omitted — both unset means ingestion isn't configured for this type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

locations-directory:support

Body Params

Fields accepted when creating an article type.

string
required
length between 1 and 128

Unique, stable identifier for the article type (used elsewhere in the article APIs as type_id). Must be unique (case-insensitive) across all article types.

string
required
length between 1 and 128

Human-readable name of the article type.

string
length ≤ 1024

Optional free-text description of the article type.

string
enum
required
length between 1 and 4

The shape of an article's content for this type. TEXT articles store free-form text; JSON articles store structured content that is validated against the type's json_schema.

Allowed:
json_schema
object

JSON Schema document that JSON-content articles of this type must conform to. Required (and validated for compilability) when content_type is JSON; ignored otherwise.

supported_link_patterns
array of objects
required
length ≥ 1

A valid entity-link shape for articles of this type. An article linked to this type must match exactly one of the type's supported_link_patterns, by cardinality and by the set of entity types in entities.

string
length between 1 and 255

Temporal task queue that routes this type's async content-ingestion workflow. Must be set together with ingestion_workflow_name, or both left unset if ingestion isn't configured for this type.

string
length between 1 and 255

Temporal workflow name for this type's async content-ingestion workflow. Must be set together with ingestion_task_queue, or both left unset if ingestion isn't configured for this type.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json