# Create agent

POST //localhost:8080/api/v1/agents
Content-Type: application/json

Create agent and auto-create Virtual Key. Returns fullToken once. Owner or admin.

Reference: https://api.alephant.io/api-reference/saa-s-api/agents/create-agent

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: saas-openapi
  version: 1.0.0
paths:
  /api/v1/agents:
    post:
      operationId: create-agent
      summary: Create agent
      description: >-
        Create agent and auto-create Virtual Key. Returns fullToken once. Owner
        or admin.
      tags:
        - subpackage_agents
      parameters:
        - name: Authorization
          in: header
          description: Bearer {access_token}
          required: true
          schema:
            type: string
        - name: X-Workspace-Id
          in: header
          description: Workspace UUID
          required: true
          schema:
            type: string
      responses:
        '201':
          description: 'data: agent + virtualKey (id, keyPrefix, fullToken)'
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '401':
          description: AUTH_TOKEN_EXPIRED
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '404':
          description: masterKeyId or departmentId NOT_FOUND
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '409':
          description: TIER_LIMIT_VK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '422':
          description: VALIDATION_ERROR
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
      requestBody:
        description: name, provider, model, masterKeyId (required)
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/internal_api_handlers_agents.CreateAgentRequest
servers:
  - url: //localhost:8080
components:
  schemas:
    internal_api_handlers_agents.CreateAgentRequest:
      type: object
      properties:
        allowedModels:
          type: array
          items:
            type: string
        budget:
          type: number
          format: double
        budgetAction:
          type: string
        budgetWindow:
          type: string
        departmentId:
          type: string
        description:
          type: string
        environment:
          type: string
        expiresAt:
          type: string
        masterKeyId:
          type: string
        model:
          type: string
        name:
          type: string
        provider:
          type: string
        rateLimitRpm:
          type: integer
      required:
        - masterKeyId
        - model
        - name
        - provider
      title: internal_api_handlers_agents.CreateAgentRequest

```

## SDK Code Examples

```python
import requests

url = "https://localhost:8080/api/v1/agents"

payload = {
    "masterKeyId": "string",
    "model": "string",
    "name": "string",
    "provider": "string"
}
headers = {
    "Authorization": "Authorization",
    "X-Workspace-Id": "X-Workspace-Id",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://localhost:8080/api/v1/agents';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Authorization',
    'X-Workspace-Id': 'X-Workspace-Id',
    'Content-Type': 'application/json'
  },
  body: '{"masterKeyId":"string","model":"string","name":"string","provider":"string"}'
};

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://localhost:8080/api/v1/agents"

	payload := strings.NewReader("{\n  \"masterKeyId\": \"string\",\n  \"model\": \"string\",\n  \"name\": \"string\",\n  \"provider\": \"string\"\n}")

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

	req.Header.Add("Authorization", "Authorization")
	req.Header.Add("X-Workspace-Id", "X-Workspace-Id")
	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://localhost:8080/api/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Authorization'
request["X-Workspace-Id"] = 'X-Workspace-Id'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"masterKeyId\": \"string\",\n  \"model\": \"string\",\n  \"name\": \"string\",\n  \"provider\": \"string\"\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.post("https://localhost:8080/api/v1/agents")
  .header("Authorization", "Authorization")
  .header("X-Workspace-Id", "X-Workspace-Id")
  .header("Content-Type", "application/json")
  .body("{\n  \"masterKeyId\": \"string\",\n  \"model\": \"string\",\n  \"name\": \"string\",\n  \"provider\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://localhost:8080/api/v1/agents', [
  'body' => '{
  "masterKeyId": "string",
  "model": "string",
  "name": "string",
  "provider": "string"
}',
  'headers' => [
    'Authorization' => 'Authorization',
    'Content-Type' => 'application/json',
    'X-Workspace-Id' => 'X-Workspace-Id',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://localhost:8080/api/v1/agents");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Authorization");
request.AddHeader("X-Workspace-Id", "X-Workspace-Id");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"masterKeyId\": \"string\",\n  \"model\": \"string\",\n  \"name\": \"string\",\n  \"provider\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Authorization",
  "X-Workspace-Id": "X-Workspace-Id",
  "Content-Type": "application/json"
]
let parameters = [
  "masterKeyId": "string",
  "model": "string",
  "name": "string",
  "provider": "string"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8080/api/v1/agents")! 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()
```