FruxonDocs
AgentsAssets

Ingest Zendesk Help Center articles as an asset

POST
/v1/tenants/{tenant}/agents/{agent}/assets:zendesk

Path Parameters

agent*string

The unique identifier of the agent

tenant*string

The tenant identifier

Zendesk ingestion parameters

subdomain*string

Zendesk subdomain (e.g. 'mycompany' for mycompany.zendesk.com)

Length1 <= length
email*string

Zendesk account email address

Length1 <= length
token*string

Zendesk API token

Length1 <= length
locale?string|null

Locale code to filter articles (e.g. 'en-us'). Omit to fetch all locales.

modelKey?string|null

Embedding model key. If omitted, the agent's default model is used.

name?string|null

Asset display name. Defaults to the subdomain if omitted

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string/assets:zendesk" \  -H "Content-Type: application/json" \  -d '{    "subdomain": "string",    "email": "string",    "token": "string"  }'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "agentId": "string",
  "name": "string",
  "status": 0,
  "documentCount": 0,
  "createdAt": 0,
  "modifiedAt": 0,
  "processedAt": 0,
  "errorMessage": "string"
}
Empty
Empty
,"method":"patch"}]} />