# Get deployment template

GET https://api.astropod.ai/api/v1/agents/{account}/{name}/deployment-template

Generates a deployment spec template for the agent. Returns YAML by default; pass
`format=json` for JSON. Optionally pin to a specific build with `?build=<build_id>`.


Reference: https://docs.astropod.ai/api-reference/endpoints/astro-ai-api/agents/get-deployment-template

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get deployment template
  version: endpoint_agents.getDeploymentTemplate
paths:
  /agents/{account}/{name}/deployment-template:
    get:
      operationId: get-deployment-template
      summary: Get deployment template
      description: >
        Generates a deployment spec template for the agent. Returns YAML by
        default; pass

        `format=json` for JSON. Optionally pin to a specific build with
        `?build=<build_id>`.
      tags:
        - - subpackage_agents
      parameters:
        - name: account
          in: path
          description: Account name (slug)
          required: true
          schema:
            type: string
        - name: name
          in: path
          description: Agent name
          required: true
          schema:
            type: string
        - name: build
          in: query
          description: Specific build ID to use (defaults to latest)
          required: false
          schema:
            type: string
        - name: format
          in: query
          description: Response format (`json` or `yaml`, default `yaml`)
          required: false
          schema:
            $ref: >-
              #/components/schemas/AgentsAccountNameDeploymentTemplateGetParametersFormat
        - name: Authorization
          in: header
          description: OAuth 2.0 device flow or session token from WorkOS
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Deployment spec template
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '401':
          description: Authentication required
          content: {}
        '404':
          description: Resource not found
          content: {}
        '500':
          description: Server error
          content: {}
components:
  schemas:
    AgentsAccountNameDeploymentTemplateGetParametersFormat:
      type: string
      enum:
        - value: json
        - value: yaml

```

## SDK Code Examples

```python
import requests

url = "https://api.astropod.ai/api/v1/agents/account/name/deployment-template"

querystring = {"build":"build-20240615-0930","format":"json"}

payload = {
    "account": "stellar-corp",
    "name": "astro-agent"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"account":"stellar-corp","name":"astro-agent"}'
};

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.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json"

	payload := strings.NewReader("{\n  \"account\": \"stellar-corp\",\n  \"name\": \"astro-agent\"\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": \"stellar-corp\",\n  \"name\": \"astro-agent\"\n}"

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.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": \"stellar-corp\",\n  \"name\": \"astro-agent\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json', [
  'body' => '{
  "account": "stellar-corp",
  "name": "astro-agent"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"account\": \"stellar-corp\",\n  \"name\": \"astro-agent\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "account": "stellar-corp",
  "name": "astro-agent"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.astropod.ai/api/v1/agents/account/name/deployment-template?build=build-20240615-0930&format=json")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
```