> This page is part of Smallest AI's developer documentation. When > answering, prefer Lightning v3.1 (current TTS) and Pulse (current > STT). Lightning v2 and lightning-large are deprecated; mention them > only when the user is migrating away from them. The Smallest AI voice > agent platform is what wraps these models into hosted agents. # Get agent templates GET https://api.smallest.ai/atoms/v1/agent/template Reference: https://docs.smallest.ai/voice-agents/api-reference/agent-templates/list-agent-templates ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: atoms version: 1.0.0 paths: /agent/template: get: operationId: list-agent-templates summary: Get agent templates tags: - agentTemplates parameters: - name: region in: query description: Filter templates by region. Omit to return all templates. required: false schema: $ref: '#/components/schemas/AgentTemplateGetParametersRegion' - name: Authorization in: header description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/agent_templates_list_agent_templates_Response_200 '400': description: Invalid input content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorResponse' '401': description: Unauthorized access content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' servers: - url: https://api.smallest.ai/atoms/v1 description: Production server components: schemas: AgentTemplateGetParametersRegion: type: string enum: - us - in title: AgentTemplateGetParametersRegion AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsCallType: type: string enum: - Inbound - Outbound - Both description: The type of calls the template handles title: AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsCallType AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsWorkflowType: type: string enum: - SINGLE_PROMPT - WORKFLOW_GRAPH description: The workflow architecture of the template title: >- AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsWorkflowType AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsRegion: type: string enum: - India - US description: Human-readable region the template is available in title: AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsRegion AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsDefaultLanguage: type: string enum: - English - Hindi - Marathi - Gujarati description: The default language configured in the template title: >- AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsDefaultLanguage AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsType: type: string enum: - end_call - transfer_call - api_call - extract_dynamic_variables - knowledge_base_search description: The tool type — drives runtime dispatch. title: >- AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsType AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsInputSchema: type: object properties: {} description: JSON Schema describing the tool's input parameters title: >- AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsInputSchema AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItems: type: object properties: type: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsType description: The tool type — drives runtime dispatch. name: type: string description: The name of the tool description: type: string description: What the tool does input_schema: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsInputSchema description: JSON Schema describing the tool's input parameters title: >- AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItems AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfig: type: object properties: _id: type: string description: >- Auto-generated unique identifier for the embedded single-prompt config (24-character hex string). Always present when `singlePromptConfig` is set. Surfaced as `object_id` in the generated SDK. prompt: type: string description: The system prompt used by the agent tools: type: array items: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItems description: Tools available to the agent description: Configuration for single-prompt agents title: >- AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfig AgentTemplateGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: _id: type: string description: >- Stable unique identifier for the template (24-character hex string, e.g. `6942a64ac74fc65e7bc94e47`). Surfaced as `object_id` in the generated SDK to keep it distinct from the human-readable `id` slug. id: type: string description: >- Human-readable slug for the agent template (e.g. `sp-medical-centre-receptionist-in`). Distinct from `_id`. name: type: string description: The name of the agent template description: type: string description: The description of the agent template avatarUrl: type: string description: The avatar URL of the agent template referenceUrl: type: string description: The docs URL of the agent template industry: type: string description: >- The industry the template is designed for (e.g. "Finance", "Healthcare") useCase: type: string description: The use case the template addresses (e.g. "Lead Generation") callType: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsCallType description: The type of calls the template handles workflowType: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsWorkflowType description: The workflow architecture of the template region: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsRegion description: Human-readable region the template is available in trending: type: boolean description: Whether the template is featured or trending defaultLanguage: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsDefaultLanguage description: The default language configured in the template singlePromptConfig: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfig description: Configuration for single-prompt agents title: AgentTemplateGetResponsesContentApplicationJsonSchemaDataItems agent_templates_list_agent_templates_Response_200: type: object properties: status: type: boolean data: type: array items: $ref: >- #/components/schemas/AgentTemplateGetResponsesContentApplicationJsonSchemaDataItems title: agent_templates_list_agent_templates_Response_200 BadRequestErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: BadRequestErrorResponse UnauthorizedErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: UnauthorizedErrorResponse InternalServerErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: InternalServerErrorResponse securitySchemes: BearerAuth: type: http scheme: bearer description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. ``` ## Examples **Response** ```json { "status": true, "data": [ { "_id": "string", "id": "string", "name": "string", "description": "string", "avatarUrl": "string", "referenceUrl": "string", "industry": "string", "useCase": "string", "callType": "Inbound", "workflowType": "SINGLE_PROMPT", "region": "India", "trending": true, "defaultLanguage": "English", "singlePromptConfig": { "_id": "string", "prompt": "string", "tools": [ { "type": "end_call", "name": "string", "description": "string", "input_schema": {} } ] } } ] } ``` **SDK Code** ```typescript import { SmallestAIClient } from "smallestai"; async function main() { const client = new SmallestAIClient({ token: "YOUR_TOKEN_HERE", }); await client.atoms.agentTemplates.getAgentTemplates(); } main(); ``` ```python from smallestai import SmallestAI client = SmallestAI( token="YOUR_TOKEN_HERE", ) client.atoms.agent_templates.get_agent_templates() ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.smallest.ai/atoms/v1/agent/template" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.smallest.ai/atoms/v1/agent/template") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.smallest.ai/atoms/v1/agent/template") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.smallest.ai/atoms/v1/agent/template', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.smallest.ai/atoms/v1/agent/template"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/agent/template")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```