Ada · Schema
Ada Knowledge Schemas
aicustomer-servicechatbotautomationconversational-aihelpdeskcrmintegrationsknowledge-managementdata-export
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Ada Knowledge Schemas",
"definitions": {
"KnowledgeSourceResponseMetadata": {
"type": "object",
"properties": {},
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.",
"title": "KnowledgeSourceResponseMetadata"
},
"KnowledgeSourceResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the knowledge source"
},
"external_id": {
"type": [
"string",
"null"
],
"description": "An external identifier for the knowledge source"
},
"name": {
"type": "string",
"description": "The name of the knowledge source"
},
"metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/KnowledgeSourceResponseMetadata"
},
{
"type": "null"
}
],
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source."
},
"created": {
"type": "string",
"format": "date-time",
"description": "The date the knowledge source was created"
},
"updated": {
"type": "string",
"format": "date-time",
"description": "The date the knowledge source was last updated"
},
"last_sync": {
"type": "string",
"format": "date-time",
"description": "The date the knowledge source was last synchronized"
}
},
"required": [
"id",
"name"
],
"title": "KnowledgeSourceResponse"
},
"knowledge_sources_list_Response_200": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KnowledgeSourceResponse"
}
}
},
"title": "knowledge_sources_list_Response_200"
},
"ErrorsErrorsItems": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The error type"
},
"message": {
"type": "string",
"description": "The error message"
},
"details": {
"type": [
"string",
"null"
],
"description": "Extra information about the error"
}
},
"required": [
"type",
"message"
],
"title": "ErrorsErrorsItems"
},
"Errors": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorsErrorsItems"
},
"description": "A list of errors"
}
},
"required": [
"errors"
],
"title": "Errors"
},
"KnowledgeSourceCreateRequestMetadata": {
"type": "object",
"properties": {},
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.",
"title": "KnowledgeSourceCreateRequestMetadata"
},
"KnowledgeSourceCreateRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the knowledge source"
},
"name": {
"type": "string",
"description": "The name of the knowledge source"
},
"metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/KnowledgeSourceCreateRequestMetadata"
},
{
"type": "null"
}
],
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source."
}
},
"required": [
"id",
"name"
],
"title": "KnowledgeSourceCreateRequest"
},
"knowledge_sources_delete_Response_204": {
"type": "object",
"properties": {},
"description": "Empty response body",
"title": "knowledge_sources_delete_Response_204"
},
"KnowledgeSourceUpdateRequestMetadata": {
"type": "object",
"properties": {},
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.",
"title": "KnowledgeSourceUpdateRequestMetadata"
},
"KnowledgeSourceUpdateRequest": {
"type": "object",
"properties": {
"external_id": {
"type": [
"string",
"null"
],
"description": "A unique identifier for the knowledge source"
},
"name": {
"type": "string",
"description": "The name of the knowledge source"
},
"metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/KnowledgeSourceUpdateRequestMetadata"
},
{
"type": "null"
}
],
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source."
}
},
"title": "KnowledgeSourceUpdateRequest"
},
"ArticleLanguage": {
"type": "string",
"enum": [
"ar",
"zh",
"zh-tw",
"da",
"nl",
"en",
"fi",
"fr",
"de",
"he",
"hi",
"id",
"in",
"it",
"ja",
"ko",
"ms",
"pt",
"pa",
"ru",
"es",
"sv",
"tl",
"ta",
"th",
"tr",
"vi",
"ht",
"my",
"km",
"bg",
"ro",
"el",
"hu",
"pl",
"cs",
"et",
"hr",
"lt",
"lv",
"sl",
"sk",
"is",
"be",
"uk",
"ca",
"sq",
"bs",
"sr",
"kk"
],
"description": "The ISO 639-1 language code of the article, defaults to `en`",
"title": "ArticleLanguage"
},
"KnowledgeArticleResponseMetadata": {
"type": "object",
"properties": {},
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article.",
"title": "KnowledgeArticleResponseMetadata"
},
"KnowledgeArticleResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the article"
},
"name": {
"type": "string",
"description": "The name or title of the article"
},
"content": {
"type": "string",
"description": "The content of the article in markdown format"
},
"url": {
"type": [
"string",
"null"
],
"format": "url",
"description": "The url of the article"
},
"knowledge_source_id": {
"type": [
"string",
"null"
],
"description": "The id of the `knowledge_source` the article belongs to"
},
"language": {
"$ref": "#/components/schemas/ArticleLanguage"
},
"tag_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of ids for the tags associated with the article"
},
"created": {
"type": "string",
"format": "date-time",
"description": "The date the article was created in Ada"
},
"updated": {
"type": "string",
"format": "date-time",
"description": "The date the article was last updated in Ada"
},
"external_created": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date the article was created in the source system"
},
"external_updated": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date the article was last updated in the source system"
},
"enabled": {
"type": "boolean",
"description": "Whether the article should be referenced during response generation, defaults to `true`"
},
"metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/KnowledgeArticleResponseMetadata"
},
{
"type": "null"
}
],
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article."
}
},
"required": [
"id",
"name",
"content"
],
"title": "KnowledgeArticleResponse"
},
"PaginationMetadata": {
"type": "object",
"properties": {
"next_page_url": {
"type": [
"string",
"null"
],
"description": "The URL to the next page of results"
}
},
"title": "PaginationMetadata"
},
"knowledge_articles_list_Response_200": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KnowledgeArticleResponse"
}
},
"meta": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"title": "knowledge_articles_list_Response_200"
},
"knowledge_articles_delete_Response_204": {
"type": "object",
"properties": {},
"description": "Empty response body",
"title": "knowledge_articles_delete_Response_204"
},
"knowledge_articles_deleteById_Response_204": {
"type": "object",
"properties": {},
"description": "Empty response body",
"title": "knowledge_articles_deleteById_Response_204"
},
"KnowledgeArticleUpsertRequestMetadata": {
"type": "object",
"properties": {},
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article.",
"title": "KnowledgeArticleUpsertRequestMetadata"
},
"KnowledgeArticleUpsertRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the article"
},
"name": {
"type": "string",
"description": "The name or title of the article"
},
"content": {
"type": "string",
"description": "The content of the article in markdown format"
},
"url": {
"type": [
"string",
"null"
],
"format": "url",
"description": "The url of the article"
},
"knowledge_source_id": {
"type": "string",
"description": "The id of the `knowledge_source` the article belongs to"
},
"tag_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of ids for the tags associated with the article"
},
"language": {
"type": "string",
"description": "The IETF BCP 47 language code for the article, defaults to `en`"
},
"external_created": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date the article was created in the source system"
},
"external_updated": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date the article was last updated in the source system"
},
"enabled": {
"type": "boolean",
"description": "Whether the article should be referenced during response generation, defaults to `true`"
},
"metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/KnowledgeArticleUpsertRequestMetadata"
},
{
"type": "null"
}
],
"description": "A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article."
}
},
"required": [
"id",
"name",
"content",
"knowledge_source_id"
],
"title": "KnowledgeArticleUpsertRequest"
},
"KnowledgeArticleUpsertResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Whether the article was successfully created/updated"
},
"created": {
"type": "boolean",
"description": "`True` if a new article was created, `false` if an existing article was updated"
},
"id": {
"type": "string",
"description": "A unique identifier for the article"
}
},
"required": [
"id"
],
"title": "KnowledgeArticleUpsertResponse"
},
"ArticleTag": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the tag"
},
"name": {
"type": "string",
"description": "The name of the tag"
}
},
"required": [
"id",
"name"
],
"title": "ArticleTag"
},
"knowledge_tags_list_Response_200": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleTag"
}
}
},
"title": "knowledge_tags_list_Response_200"
},
"knowledge_tags_delete_Response_204": {
"type": "object",
"properties": {},
"description": "Empty response body",
"title": "knowledge_tags_delete_Response_204"
},
"ArticleTagUpsertResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Whether the article tag was successfully created/updated"
},
"created": {
"type": "boolean",
"description": "`True` if a new article tag was created, `false` if an existing article tag was updated"
},
"id": {
"type": "string",
"description": "The id of the article tag"
}
},
"required": [
"success",
"created",
"id"
],
"title": "ArticleTagUpsertResponse"
},
"EndUserProfileSystemProperties": {
"type": "object",
"properties": {
"sunshine_user_id": {
"type": [
"string",
"null"
],
"description": "The Sunshine Conversations user id for the end user"
}
},
"description": "Read-only profile information set by Ada",
"title": "EndUserProfileSystemProperties"
},
"EndUserProfile": {
"type": "object",
"properties": {
"first_name": {
"type": [
"string",
"null"
],
"description": "The end user's first name"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The end user's last name"
},
"display_name": {
"type": [
"string",
"null"
],
"description": "The end user's display name"
},
"avatar": {
"type": [
"string",
"null"
],
"description": "URL to the end user's avatar image"
},
"email": {
"type": [
"string",
"null"
],
"description": "The end user's email address"
},
"language": {
"type": [
"string",
"null"
],
"description": "The end user's language in BCP 47 format"
},
"metadata": {
"type": "object",
"additionalProperties": {
"description": "Any type"
},
"description": "A dictionary of arbitrary key, value pairs assigned to the end user - `metadata` keys may only be of type: `string` - `metadata` values may only be one of type: `string`, `boolean`, or `integer`"
},
"system_properties": {
"$ref": "#/components/schemas/EndUserProfileSystemProperties",
"description": "Read-only profile information set by Ada"
}
},
"description": "The end user's profile information",
"title": "EndUserProfile"
},
"EndUser": {
"type": "object",
"properties": {
"end_user_id": {
"type": "string",
"description": "The unique Ada-generated id for the end user"
},
"external_id": {
"type": [
"string",
"null"
],
"description": "Caller-supplied identifier that links this end user to your own system (for example a CRM contact ID or a phone number). Unique per AI Agent. Null if not set. Maximum 36 characters; values are case-insensitive. Available for custom channel integrations only (V1)."
},
"profile": {
"$ref": "#/components/schemas/EndUserProfile",
"description": "The end user's profile information"
},
"created_at": {
"type": "string",
"description": "The date and time the end user was created"
},
"updated_at": {
"type": "string",
"description": "The date and time the end user was updated"
}
},
"title": "EndUser"
},
"EndUserRequestProfileSensitiveMetadataFields": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
],
"title": "EndUserRequestProfileSensitiveMetadataFields"
},
"EndUserRequestProfileSensitiveMetadata": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/EndUserRequestProfileSensitiveMetadataFields"
},
{
"type": "null"
}
]
},
"description": "A dictionary of sensitive key-value pairs. Keys must match the pattern [A-Za-z0-9_-]+. Values must be non-empty strings, booleans, integers, or null. Setting a key to null removes the metavariable. Maximum 20 key-value pairs per request."
}
},
"required": [
"fields"
],
"description": "Sensitive key-value pairs to update on the end user. Values are stored in an encrypted, isolated store and are never returned in any API response, dashboard view, conversation transcript, or LLM prompt. Values are automatically and permanently deleted after 24 hours.",
"title": "EndUserRequestProfileSensitiveMetadata"
},
"EndUserRequestProfile": {
"type": "object",
"properties": {
"first_name": {
"type": [
"string",
"null"
],
"description": "The end user's first name"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The end user's last name"
},
"display_name": {
"type": [
"string",
"null"
],
"description": "The end user's display name"
},
"avatar": {
"type": [
"string",
"null"
],
"description": "URL to the end user's avatar image"
},
"email": {
"type": [
"string",
"null"
],
"description": "The end user's email address"
},
"language": {
"type": [
"string",
"null"
],
"description": "The end user's language in BCP 47 format"
},
"metadata": {
"type": [
"object",
"null"
],
"additionalProperties": {
"description": "Any type"
},
"description": "A dictionary of arbitrary key, value pairs assigned to the end user.\n<br>- `metadata` keys may only be of type: `string`\n<br>- `metadata` values may only be one of type: `string`, `boolean`, or `integer`\n<br>**Note**: The total size of metadata is limited to 10KB.</br>\n"
},
"sensitive_metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/EndUserRequestProfileSensitiveMetadata"
},
{
"type": "null"
}
],
"description": "Sensitive key-value pairs to update on the end user. Values are stored in an encrypted, isolated store and are never returned in any API response, dashboard view, conversation transcript, or LLM prompt. Values are automatically and permanently deleted after 24 hours."
}
},
"description": "The end user's profile information",
"title": "EndUserRequestProfile"
},
"EndUserRequest": {
"type": "object",
"properties": {
"external_id": {
"type": [
"string",
"null"
],
"description": "Set or update the external identifier for this end user. Pass null to remove the current external_id. Must be unique per AI Agent; maximum 36 characters; must not contain < or > characters. Values are stored case-insensitively. Returns 409 if the external_id is already assigned to a different end user. Available for custom channel integrations only (V1)."
},
"profile": {
"$ref": "#/components/schemas/EndUserRequestProfile",
"description": "The end user's profile information"
}
},
"required": [
"profile"
],
"title": "EndUserRequest"
},
"CursorPaginationMetadata": {
"type": "object",
"properties": {
"next_page_url": {
"type": "string",
"format": "url",
"description": "Link to the next page of data using a cursor value"
}
},
"description": "Metadata returned with the results including but not limited to a link to the next page of data",
"title": "CursorPaginationMetadata"
},
"EndUsers": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndUser"
},
"description": "The list of end user profiles"
},
"meta": {
"$ref": "#/components/schemas/CursorPaginationMetadata"
}
},
"title": "EndUsers"
},
"End Users_getEndUsers_Response_200": {
"oneOf": [
{
"$ref": "#/components/schemas/EndUser"
},
{
"$ref": "#/components/schemas/EndUsers"
}
],
"title": "End Users_getEndUsers_Response_200"
},
"CreateEndUserRequestProfileSensitiveMetadataFields": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
],
"title": "CreateEndUserRequestProfileSensitiveMetadataFields"
},
"CreateEndUserRequestProfileSensitiveMetadata": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateEndUserRequestProfileSensitiveMetadataFields"
},
{
"type": "null"
}
]
},
"description": "A dictionary of sensitive key-value pairs. Keys must match the pattern [A-Za-z0-9_-]+. Values must be non-empty strings, booleans, integers, or null. Maximum 20 key-value pairs per request. Keys must not overlap with keys in the sibling metadata field."
}
},
"required": [
"fields"
],
"description": "Sensitive key-value pairs to associate with the end user at creation time. Values are stored in an encrypted, isolated store and are never returned in any API response, dashboard view, conversation transcript, or LLM prompt. Values are automatically and permanently deleted after 24 hours.",
"title": "CreateEndUserRequestProfileSensitiveMetadata"
},
"CreateEndUserRequestProfile": {
"type": "object",
"properties": {
"first_name": {
"type": [
"string",
"null"
],
"description": "The end user's first name"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The end user's last name"
},
"display_name": {
"type": [
"string",
"null"
],
"description": "The end user's display name"
},
"avatar": {
"type": [
"string",
"null"
],
"description": "URL to the end user's avatar image"
},
"email": {
"type": [
"string",
"null"
],
"description": "The end user's email address"
},
"language": {
"type": [
"string",
"null"
],
"description": "The end user's language in BCP 47 format"
},
"metadata": {
"type": [
"object",
"null"
],
"additionalProperties": {
"description": "Any type"
},
"description": "A dictionary of arbitrary key, value pairs assigned to the end user.\n<br>- `metadata` keys may only be of type: `string`\n<br>- `metadata` values may only be one of type: `string`, `boolean`, or `integer`\n<br>**Note**: The total size of metadata is limited to 10KB.</br>\n"
},
"sensitive_metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateEndUserRequestProfileSensitiveMetadata"
},
{
"type": "null"
}
],
"description": "Sensitive key-value pairs to associate with the end user at creation time. Values are stored in an encrypted, isolated store and are never returned in any API response, dashboard view, conversation transcript, or LLM prompt. Values are automatically and permanently deleted after 24 hours."
}
},
"description": "The end user's profile information. Optional \u2014 omitting profile creates a blank end user.",
"title": "CreateEndUserRequestProfile"
},
"CreateEndUserRequest": {
"type": "object",
"properties": {
"external_id": {
"type": [
"string",
"null"
],
"description": "Optional caller-supplied identifier (for example a CRM contact ID or a phone number). Maximum 36 characters; must not contain < or > characters. Values are stored case-insensitively. If an end user with this external_id already exists, that existing user is returned with HTTP 200 (idempotent upsert); otherwise a new end user is created with HTTP 201. Available for custom channel integrations only (V1)."
},
"profile": {
"$ref": "#/components/schemas/CreateEndUserRequestProfile",
"description": "The end user's profile information. Optional \u2014 omitting profile creates a blank end user."
}
},
"title": "CreateEndUserRequest"
},
"IntegrationIdentifierField": {
"type": "string",
"description": "JMESPath describing which of the fields in `configuration_fields` is the best human-friendly field to use to identify a specific installation (e.g., account name)",
"title": "IntegrationIdentifierField"
},
"IntegrationIconUrl": {
"type": [
"string",
"null"
],
"format": "url",
"description": "The URL of the icon that should be displayed with your integration",
"title": "IntegrationIconUrl"
},
"IntegrationCallToAction": {
"type": [
"string",
"null"
],
"description": "The call to action text",
"title": "IntegrationCallToAction"
},
"PlatformIntegrationTagsItems": {
"type": "string",
"enum": [
"knowledge"
],
"title": "PlatformIntegrationTagsItems"
},
"PlatformIntegrationErrorCodes": {
"type": "object",
"properties": {},
"description": "An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed",
"title": "PlatformIntegrationErrorCodes"
},
"PlatformIntegrationConfigurationFields": {
"type": "object",
"properties": {},
"description": "A json-schema describing the settings fields that a user should be presented with when installing the integration",
"title": "PlatformIntegrationConfigurationFields"
},
"PlatformIntegration": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the integration"
},
"status": {
"type": "string",
"description": "The current state of the integration (development, approved, archived)"
},
"created": {
"type": "string",
"format": "date-time",
"description": "The date the integration was created"
},
"updated": {
"type": "string",
"format": "date-time",
"description": "The date the integration was last updated"
},
"identifier_field_path": {
"$ref": "#/components/schemas/IntegrationIdentifierField"
},
"icon_url": {
"$ref": "#/components/schemas/IntegrationIconUrl"
},
"call_to_action": {
"$ref": "#/components/schemas/IntegrationCallToAction"
},
"name": {
"type": "string",
"description": "The name of the integration"
},
"description": {
"type": "string",
"description": "A description of what the integration does and how to use it"
},
"author": {
"type": "string",
"description": "The name of the integration developer"
},
"contact": {
"type": "string",
"description": "The URL or email address where users of the integration can reach out for support"
},
"uninstallation_url": {
"type": "string",
"format": "url",
"description": "The `delete` endpoint that initiates the uninstallation flow for the integration"
},
"oauth_callback_url": {
"
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ada/refs/heads/main/json-schema/ada-knowledge-schemas.json