--- updatedAt: 2026-04-29T16:33:48.000Z agentTools: projectIndex: https://docs.customgpt.ai/llms.txt --- # Get message claims. Returns the factual claims extracted from an agent's response. Each claim is a discrete statement that can be independently verified against the source documents. Use this for fact-checking or building trust indicators. # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "CustomGPT.ai", "description": "API Documentation for CustomGPT.ai.", "contact": { "name": "CustomGPT.ai", "url": "https://app.customgpt.ai", "email": "hello@customgpt.ai" }, "version": "1.0.0" }, "servers": [ { "url": "https://app.customgpt.ai", "description": "API Version 1" } ], "paths": { "/api/v1/projects/{projectId}/conversations/{sessionId}/messages/{promptId}/claims": { "get": { "tags": [ "Message" ], "summary": "Get message claims.", "description": "Returns the factual claims extracted from an agent's response. Each claim is a discrete statement that can be independently verified against the source documents. Use this for fact-checking or building trust indicators.", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the agent to get the messages for", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "sessionId", "in": "path", "description": "The session ID of the conversation to get the messages for", "required": true, "schema": { "type": "string", "example": "1" } }, { "name": "promptId", "in": "path", "description": "The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint.", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "$ref": "#/components/responses/GetMessageClaimsResponse" }, "400": { "$ref": "#/components/responses/BadArgumentErrorResponse" }, "401": { "$ref": "#/components/responses/ApiTokenValidationErrorResponse" }, "404": { "$ref": "#/components/responses/ConversationMessageNotFoundErrorResponse" }, "500": { "$ref": "#/components/responses/InternalServerErrorResponse" } }, "security": [ { "BearerToken": [] } ] } } }, "components": { "schemas": { "ExplainabilityClaims": { "description": "Explainability claims generated for a given message", "type": "object", "properties": { "extracted_claims": { "description": "List of extracted claims with the supporting evidence and explanations", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique claim identifier", "type": "string", "example": "claim_1" }, "text": { "description": "The extracted claim text", "type": "string", "example": "CustomGPT is a user-friendly, no-code AI platform." }, "status": { "description": "Verification status of the claim", "enum": [ "VERIFIED", "UNVERIFIED" ], "type": "string", "example": "VERIFIED" }, "sources": { "description": "List of sources supporting the claim", "type": "array", "items": { "type": "object", "properties": { "source": { "description": "Source URL", "type": "string", "example": "https://customgpt.ai/industry/..." }, "source_sentence": { "description": "Relevant sentence from the source", "type": "string", "example": "No technical expertise is needed." } } } }, "source_sentence": { "description": "The original sentence from which the claim was extracted", "type": "string", "example": "CustomGPT.ai is a user-friendly, no-code platform designed for easy deployment." }, "source_explanation": { "description": "Detailed explanation of how the evidence supports or contradicts the claim", "type": "string", "example": "The source sentence confirms..." } } } }, "evaluation_duration_ms": { "description": "Time taken for the claim extraction and evaluation (in milliseconds)", "type": "number", "nullable": true, "example": 28466.99 } } } }, "responses": { "ApiTokenValidationErrorResponse": { "description": "API Token is either missing or invalid", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "The status of the response", "enum": [ "error", "success" ], "type": "string", "example": "error" }, "url": { "description": "The URL of the request", "type": "string", "example": "https://app.customgpt.ai/api/v1/projects/1" }, "data": { "type": "object", "properties": { "code": { "description": "The error status code", "enum": [ 400, 401, 403, 404, 422, 500, 503 ], "type": "integer", "example": 401 }, "message": { "type": "string", "example": "API Token is either missing or invalid" } } } } } } } }, "BadArgumentErrorResponse": { "description": "Bad Argument", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "The status of the response", "enum": [ "error", "success" ], "type": "string", "example": "error" }, "url": { "description": "The URL of the request", "type": "string", "example": "https://app.customgpt.ai/api/v1/projects/1" }, "data": { "type": "object", "properties": { "code": { "description": "The error status code", "enum": [ 400, 401, 403, 404, 422, 500, 503 ], "type": "integer", "example": 400 }, "message": { "description": "The error message", "type": "string", "example": "Agent id must be integer" } } } } } } } }, "ConversationMessageNotFoundErrorResponse": { "description": "Conversation message not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "The status of the response", "enum": [ "error", "success" ], "type": "string", "example": "error" }, "url": { "description": "The URL of the request", "type": "string", "example": "https://app.customgpt.ai/api/v1/projects/1" }, "data": { "type": "object", "properties": { "code": { "description": "The error status code", "enum": [ 400, 401, 403, 404, 422, 500, 503 ], "type": "integer", "example": 404 }, "message": { "description": "The error message", "enum": [ "Conversation message id is required", "Conversation message with id {messageId} not found" ], "type": "string", "example": "Conversation message with id 1 not found" } } } } } } } }, "GetMessageClaimsResponse": { "description": "Retrieve explainability claims for a message", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "The status of the response", "enum": [ "error", "success" ], "type": "string", "example": "success" }, "data": { "$ref": "#/components/schemas/ExplainabilityClaims" } } } } } }, "InternalServerErrorResponse": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "The status of the response", "enum": [ "error", "success" ], "type": "string", "example": "error" }, "url": { "description": "The URL of the request", "type": "string", "example": "https://app.customgpt.ai/api/v1/projects/1" }, "data": { "type": "object", "properties": { "code": { "description": "The error status code", "enum": [ 400, 401, 403, 404, 422, 500, 503 ], "type": "integer", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } } } } } } } } }, "securitySchemes": { "BearerToken": { "type": "http", "description": "HTTP Bearer authentication using a CustomGPT API token.\n\nHow to obtain a token:\n1. Log in to your CustomGPT dashboard\n2. Go to Developers page in the sidebar\n3. Click Create new key and copy the token\n\nUsage: Include the token in every request:\n Authorization: Bearer YOUR_API_TOKEN\n\nTokens do not expire by default but can be configured to expire. Token also can be revoked from the dashboard. A missing or invalid token returns 401 Unauthorized.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true } } ```