> 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. # Create a campaign POST https://api.smallest.ai/atoms/v1/campaign Content-Type: application/json Create a campaign Reference: https://docs.smallest.ai/api-reference/voice-agents/campaigns/create ## 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 ### Body (application/json) This endpoint expects an object. - `name` (string, required) — The name of the campaign - `audienceId` (string, required) — The ID of the audience - `agentId` (string, required) — The ID of the agent - `description` (string, optional) — The description of the campaign - `fromNumbers` (list of string, optional) — The caller IDs this campaign presents, E.164 with the leading `+`, each matched against numbers your organization owns. Several numbers rotate positionally across calls; retries reuse the number the recipient already saw. The list is frozen on the campaign at creation. A campaign cannot be created without at least one resolvable number (`400` "Choose at least one number to call from"); one bad number fails the whole request. - `scheduledAt` (datetime, optional) — Optional ISO-8601 timestamp for when the campaign should start dialing. Must be in the future. If provided, the campaign is created in `scheduled` status; otherwise it starts in `draft` status and must be started manually. - `maxRetries` (integer, optional, default: 3) — Maximum number of times a failed call is retried before the participant is marked as failed. `0` disables retries. - `retryDelay` (integer, optional, default: 15) — Delay in minutes between retry attempts for a failed call. - `phoneNumberIds` (list of string, optional, deprecated) — Legacy alias for `fromNumbers`: caller-ID phone number IDs, resolved to their numbers at creation. Ignored when `fromNumbers` is present. Prefer `fromNumbers`. ## Response ### 201 Campaign created successfully. Note: `agentId` and `audienceId` are plain id strings in this response, not the nested objects the GET endpoints return. - `status` (boolean, optional) - `data` (CampaignPostResponsesContentApplicationJsonSchemaData, 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) ### 403 Forbidden Error Forbidden access - `status` (boolean, optional) - `data` (ApiResponseData, optional) ### 500 Internal Server Error Internal server error - `status` (boolean, optional) - `errors` (list of string, optional) ## Types ### CampaignPostResponsesContentApplicationJsonSchemaData - `_id` (string, optional) — The unique identifier for the campaign - `name` (string, optional) — The name of the campaign - `description` (string, optional) — The description of the campaign - `organization` (string, optional) — The ID of the organization - `agentId` (string, optional) — Raw agent id string (not a nested object) - `createdBy` (string, optional) — The ID of the user who created the campaign - `audienceId` (string, optional) — Raw audience id string (not a nested object) - `participantsCount` (integer, optional) — The number of participants in the campaign - `scheduledAt` (datetime, optional) — The scheduled start time, if provided at creation. - `maxRetries` (integer, optional) — Maximum retries per failed call (echoes request). - `retryDelay` (integer, optional) — Delay in minutes between retry attempts (echoes request). - `retryAttempts` (integer, optional) — Number of retries attempted so far across the campaign. - `status` (enum, optional) — Current campaign status. - Allowed values: `draft`, `scheduled`, `processing`, `running`, `paused`, `completed`, `failed` - `createdAt` (datetime, optional) — The date and time when the campaign was created - `updatedAt` (datetime, optional) — The date and time when the campaign was last updated ### ApiResponseData ## Examples **Request** ```json { "name": "My Campaign", "audienceId": "60d0fe4f5311236168a109ca", "agentId": "60d0fe4f5311236168a109ca" } ``` **Response** ```json { "status": true, "data": { "_id": "string", "name": "string", "description": "string", "organization": "string", "agentId": "string", "createdBy": "string", "audienceId": "string", "participantsCount": 1, "scheduledAt": "2024-01-15T09:30:00Z", "maxRetries": 1, "retryDelay": 1, "retryAttempts": 1, "status": "draft", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z" } } ``` **SDK Code** ```python import requests url = "https://api.smallest.ai/atoms/v1/campaign" payload = { "name": "My Campaign", "audienceId": "60d0fe4f5311236168a109ca", "agentId": "60d0fe4f5311236168a109ca" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.smallest.ai/atoms/v1/campaign'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"My Campaign","audienceId":"60d0fe4f5311236168a109ca","agentId":"60d0fe4f5311236168a109ca"}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://api.smallest.ai/atoms/v1/campaign" payload := strings.NewReader("{\n \"name\": \"My Campaign\",\n \"audienceId\": \"60d0fe4f5311236168a109ca\",\n \"agentId\": \"60d0fe4f5311236168a109ca\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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/campaign") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"My Campaign\",\n \"audienceId\": \"60d0fe4f5311236168a109ca\",\n \"agentId\": \"60d0fe4f5311236168a109ca\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.smallest.ai/atoms/v1/campaign") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"My Campaign\",\n \"audienceId\": \"60d0fe4f5311236168a109ca\",\n \"agentId\": \"60d0fe4f5311236168a109ca\"\n}") .asString(); ``` ```php request('POST', 'https://api.smallest.ai/atoms/v1/campaign', [ 'body' => '{ "name": "My Campaign", "audienceId": "60d0fe4f5311236168a109ca", "agentId": "60d0fe4f5311236168a109ca" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.smallest.ai/atoms/v1/campaign"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"My Campaign\",\n \"audienceId\": \"60d0fe4f5311236168a109ca\",\n \"agentId\": \"60d0fe4f5311236168a109ca\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "My Campaign", "audienceId": "60d0fe4f5311236168a109ca", "agentId": "60d0fe4f5311236168a109ca" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/campaign")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```