> 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/api-reference/voice-agents/agent-templates/list-agent-templates

## Authentication

- `Authorization` header (bearer token, required) — API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

## Request

### Query parameters

- `region` (enum, optional) — Filter templates by region. Omit to return all templates.
  - Allowed values: `us`, `in`

## Response

### 200

Successful response

- `status` (boolean, optional)
- `data` (list of AgentTemplateGetResponsesContentApplicationJsonSchemaDataItems, optional)

## Errors

### 400 Bad Request Error

Invalid input

- `status` (boolean, optional)
- `errors` (list of string, optional)

### 401 Unauthorized Error

Unauthorized access

- `status` (boolean, optional)
- `errors` (list of string, optional)

### 500 Internal Server Error

Internal server error

- `status` (boolean, optional)
- `errors` (list of string, optional)

## Types

### AgentTemplateGetResponsesContentApplicationJsonSchemaDataItems

- `_id` (string, optional) — 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` (string, optional) — Human-readable slug for the agent template (e.g. `sp-medical-centre-receptionist-in`). Distinct from `_id`.
- `name` (string, optional) — The name of the agent template
- `description` (string, optional) — The description of the agent template
- `avatarUrl` (string, optional) — The avatar URL of the agent template
- `referenceUrl` (string, optional) — The docs URL of the agent template
- `industry` (string, optional) — The industry the template is designed for (e.g. "Finance", "Healthcare")
- `useCase` (string, optional) — The use case the template addresses (e.g. "Lead Generation")
- `callType` (enum, optional) — The type of calls the template handles
  - Allowed values: `Inbound`, `Outbound`, `Both`
- `workflowType` (enum, optional) — The workflow architecture of the template
  - Allowed values: `SINGLE_PROMPT`, `WORKFLOW_GRAPH`
- `region` (enum, optional) — Human-readable region the template is available in
  - Allowed values: `India`, `US`
- `trending` (boolean, optional) — Whether the template is featured or trending
- `defaultLanguage` (enum, optional) — The default language configured in the template
  - Allowed values: `English`, `Hindi`, `Marathi`, `Gujarati`
- `singlePromptConfig` (AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfig, optional) — Configuration for single-prompt agents

### AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfig

Configuration for single-prompt agents

- `_id` (string, optional) — 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` (string, optional) — The system prompt used by the agent
- `tools` (list of AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItems, optional) — Tools available to the agent

### AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItems

- `type` (enum, optional) — The tool type — drives runtime dispatch.
  - Allowed values: `end_call`, `transfer_call`, `api_call`, `extract_dynamic_variables`, `knowledge_base_search`
- `name` (string, optional) — The name of the tool
- `description` (string, optional) — What the tool does
- `input_schema` (AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsInputSchema, optional) — JSON Schema describing the tool's input parameters

### AgentTemplateGetResponsesContentApplicationJsonSchemaDataItemsSinglePromptConfigToolsItemsInputSchema

JSON Schema describing the tool's input parameters

## 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**

```python
import requests

url = "https://api.smallest.ai/atoms/v1/agent/template"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/agent/template';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```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 <token>")

	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 <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.smallest.ai/atoms/v1/agent/template")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.smallest.ai/atoms/v1/agent/template', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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 <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

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()
```