On this page
knowledge.reembed
Build a new knowledge generation
Request
POST /api/v1/knowledge/reembed
- MCP:
knowledge_reembed - SDK:
client.knowledge.reembed(SDK path arguments usepath; MCP usesparams). - Minimum API key role: member.
- Idempotency: required_header. Send an
Idempotency-Keyheader; MCP usesidempotency_key. Reuse it after an unknown outcome.
Use the request schema below. Read IDs from earlier operation results.
Input schema
json
{
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KnowledgeReembedRequest"
}
}
}
}
}
Responses
json
{
"202": {
"description": "Build a new knowledge generation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KnowledgeStatus"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
json
{
"components": {
"schemas": {
"KnowledgeReembedRequest": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"KnowledgeStatus": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"model_identity": {
"allOf": [
{
"$ref": "#/components/schemas/ModelIdentity"
}
],
"nullable": true
},
"dimension": {
"type": "integer",
"exclusiveMinimum": true,
"minimum": 0,
"nullable": true
},
"generation": {
"type": "object",
"properties": {
"generation_id": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string",
"enum": [
"building",
"ready",
"failed"
]
},
"document_count": {
"type": "integer",
"minimum": 0
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"generation_id",
"state",
"document_count",
"created_at"
],
"additionalProperties": false,
"nullable": true
},
"pending_documents": {
"type": "integer",
"minimum": 0
}
},
"required": [
"configured",
"model_identity",
"dimension",
"generation",
"pending_documents"
],
"additionalProperties": false
},
"ModelIdentity": {
"type": "object",
"properties": {
"model_id": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"provider": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"tier": {
"type": "string",
"enum": [
"frontier",
"cumulus-served",
"customer-gpu"
]
}
},
"required": [
"model_id",
"provider",
"tier"
],
"additionalProperties": false
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.
Related guides
Content version 7cf2db89Markdown source