---
title: "Register agent"
method: POST
path: "/register"
tags: ["registration"]
---

# Register agent

`POST /register`

Register a new agent with the server

## Request body

- ConfigRegistrationRequest
  - `environment` ModelsEnvironmentConfig
    - `architecture` string — amd64, arm64
    - `config` ModelsBasicConfig
    - `ephemeral` boolean — true if running in an ephemeral environment
    - `hostname` string
    - `metaData` ModelsBasicConfig
    - `name` string — This is the name of the environment or hostname
    - `operatingSystem` string — Operating System details
    - `operatingSystemVersion` string — e.g. 10, 11, 12 for macOS
    - `platform` 'aws' | 'gcp' | 'azure' | 'kubernetes' | 'local'

## Response `200`

Registration successful

- ConfigRegistrationResponse
  - `providers` ConfigProviderConfig
    - `definitions` object — Load providers directly from config using mapstructure:",remain"
    - `path` string
    - `plugins` ConfigProviderPluginConfig
      - `definitions` object — Load providers directly from config using mapstructure:",remain"
      - `path` string
      - `url` string
    - `url` ModelEndpoint
    - `vault` string — vault secret / path to use
  - `roles` ConfigRoleConfig
    - `definitions` object — Store everything in memory
    - `path` string
    - `url` ModelEndpoint
    - `vault` string — vault secret / path to use
  - `services` ModelsServicesConfig
    - `encryption` ModelsServiceConfig
      - `config` ModelsBasicConfig
      - `provider` string — aws|gcp|azure|local
    - `largeLanguageModel` ModelsLargeLanguageModelConfig
      - `apikey` string
      - `baseURL` string — e.g. https://api.openai.com/v1
      - `model` string — e.g. gpt-4, gpt-3.5-turbo, etc
      - `provider` 'openai' | 'gemini' | 'anthropic' — e.g. openai, azure, etc
    - `scheduler` ModelsServiceConfig
      - `config` ModelsBasicConfig
      - `provider` string — aws|gcp|azure|local
    - `temporal` ModelsTemporalConfig
      - `apiKey` string
      - `host` string
      - `mtlsCertificate` string
      - `mtlsCertificatePath` string
      - `namespace` string
      - `port` integer
    - `vault` ModelsServiceConfig
      - `config` ModelsBasicConfig
      - `provider` string — aws|gcp|azure|local
  - `success` boolean
  - `workflows` ConfigWorkflowConfig
    - `definitions` object — Store everything in memory
    - `path` string
    - `plugins` ConfigWorkflowPluginConfig
      - `definitions` object — Store everything in memory
      - `path` string
      - `url` string
    - `url` ModelEndpoint
    - `vault` string — vault secret / path to use

## Other responses

- `400` — Bad request

---

[API](https://skmtc.dev/thand-io/apis/thand-agent-api.md) · [All operations](https://skmtc.dev/thand-io/apis/thand-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thand-io/apis/thand-agent-api/revisions/811b21b91b26?raw)