​
SketricGen Agent Response API

​
Overview

The SketricGen Agent Response API allows you to send messages to your SketricGen AI agents and receive AI-powered responses. This API enables seamless integration between your applications and SketricGen conversational AI.

​
Base Information

  • Endpoint: POST https://api.sketricgen.ai/v1/agent-response
  • Authentication: API Key + User ID
  • Content Type: application/json
  • Method: POST

​
Authentication

All requests must include authentication headers:

HeaderTypeRequiredDescription
X-API-KEYstring✅User’s API key for authentication
X-USER-IDstring✅User’s UUID for identification

​
Request Schema

​
Headers

{
  "X-API-KEY": "your_api_key_here",
  "X-USER-ID": "your_user_uuid_here",
  "Content-Type": "application/json"
}

​
Request Body

{
  "message": "string",
  "agent_id": "string",
  "contact_id": "string" // optional
}

​
Parameters

ParameterTypeRequiredDescription
messagestring✅The user’s message text to process
agent_idstring✅SketricGen agent identifier
contact_idstring❌Unique identifier for the contact/conversation. If not provided, a random ID will be generated

​
Response Schema

​
Success Response (200)

{
  "success": true,
  "agent_response": "Hello! I'd be happy to help you with your order. Could you please provide me with your order number?",
  "contact_id": "customer_67890"
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
agent_responsestringAI-generated response from your SketricGen agent
contact_idstringContact identifier for conversation continuity

​
Error Responses

​
Authentication Required (401)

{
  "success": false,
  "message": "Authentication failed"
}

​
Invalid Request (400)

{
  "success": false,
  "message": "Missing required parameters"
}

​
Testing

​
cURL Example

curl -X POST https://api.sketricgen.ai/v1/agent-response \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key_here" \
  -H "X-USER-ID: your_user_uuid_here" \
  -d '{
    "message": "Hello, I need help with my order",
    "agent_id": "agent_12345",
    "contact_id": "customer_67890"
  }'

​
Getting Started

​
1. Obtain API Credentials

  • Get your API key from your SketricGen dashboard
  • Note your User ID from your account settings

​
2. Set Up Your Agent

  • Create and configure your AI agent in the SketricGen platform
  • Note the agent_id for API calls

Last Updated: June 18, 2025